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

Prerequisites

  • We assume that you already have a GitHub account (In case you don’t have one already, simply go to: https://github.com/join)
  • You should have an SSH key added to your Github account
  • You should have git working on your computer

as well as having Python installed

Set up Python

Part of this lesson consists in learning how to make scripts exit correctly. At some point, we will need to test exit codes with Pytest, Python testing tool.

To know whether your Python has pytest, just run python -c "import pytest". If this command returns nothing, it means everything is fine. Otherwise, please visit https://docs.pytest.org/en/stable/getting-started.html for installation.

Set up ACT

We will need the nektos/act tool to run GitHub Actions locally.

Make sure you have it properly installed. Instructions can be found at this web page https://github.com/nektos/act.

Once the installation is done, you can run a quick test:

act --version

Set up Docker

nektos/act uses Docker to run GitHub Actions on your computer. Therefore you must have Docker installed.

If this is not the case, follow the above link for instuctions.

To check your installation open a terminal and run:

  docker --version

Note that you may have to run with sudo. If you don’t want to preface the docker command with sudo, you may need to checkout https://docs.docker.com/engine/install/linux-postinstall/.

Set up the code

If you’re having issues, please let us know immediately since you might not be able to follow this lesson without a proper setup.