Continuous Integration / Continuous Development (CI/CD) - Github Edition: Introduction

GitHub is a version control distributed git platform used for code hosting and collaboration. Yet it can be used to automatically run the hosted code on Github’s servers via GitHub Actions. Actions are workflow automation scripts. We’ll learn how to develop on to make our code robust to errors, preserved, and reproducible.

The aim of this module is to:


This assumes that

  1. you have some basic background with your command line, for example:
    • How to execute custom shell scripts
    • How to run python scripts
  2. you have gone through all previous sessions in this workshop.

The skills we’ll focus on:

  1. Making scripts exit correctly
  2. Building a CI/CD workflow of unlimited potential
  3. Understanding how job runners work (and get access to your clones)
  4. Protecting secret information while allowing jobs to run

The HSF Training Curriculum

HSF Logo
This training module is part of the Training Curriculum, a series of training modules that serves HEP newcomers the software skills needed as they enter the field, and in parallel, instill best practices for writing software.


Setup What do I need to start?
00:00 1. Introduction What is continuous integration / continuous deployment?
00:05 2. Exit (light) Codes What is an exit code?
00:25 3. Being Assertive What happens with assertions in python?
00:35 4. Understanding Yet Another Markup Language What is YAML?
00:40 5. YAML and GitHub Actions What is the GitHub Actions specification?
00:45 6. Coffee break! Get up, stretch out, take a short break.
01:00 7. Hello CI World How do I run a simple GitHub Actions job?
01:15 8. Adding CI to Your Existing Code I have code already in GitHub, how can I add CI to it?
01:30 9. Matrix How can we make job templates?
01:45 10. Coffee break! Get up, stretch out, take a short break.
02:00 11. Dependent Jobs How do you make some jobs run after other jobs?
02:10 12. A Skimmer Higgs How can I run my skimming code in the GitHub Actions?
02:25 13. Getting into the Spy Game How can I give my GitHub actions private information?
02:40 14. Making Plots to Take Over The World How do we make plots?
02:55 15. Let's Actually Make A Test (For Real) I’m out of questions.
03:20 16. Homework If you have any, ask on Mattermost channel!
03:50 Finish

The actual schedule may vary slightly depending on the topics and exercises chosen by the instructor.