CI/CD

CI/CD#

Workflows#

GitHub workflows with continuous integration is included. The GitHub workflows send their tasks to GitHub runners by default. If you want to route jobs to your self-hosted runners make sure to add a label. The steps are:

Settings › Actions › Runners › Self Hosted Runner › Create Label

You can now have your workflows send jobs to macos-latest runner by specifying the following in the workflow.yml file:

jobs:
  test:
    # Set the OS and python versions
    runs-on: macos-latest

[!IMPORTANT] If your self-hosted runner is given a label that also matches a GitHub runner (i.e. ubuntu-latest) then your job can be scheduled by self-hosted or GitHub runners. This is useful for situations where you want the job to have the option of running on either kind of runners.

Badges#

The badge at the top of the README.md will update its status to display whether the CI process succeeds/fails. Modify it to point to your own repo when starting a new project.

Git Runner Limits#

If you are running into rate limiting issues with Git runner you will need to add an authorization token to your Git actions. The GitHub token must be generated from the public GitHub and not your self-hosted GitHub. This is because the libraries being installed are sourced from the public GitHub.

  • Generate a GitHub token here.

  • Navigate to Repo › Settings › Secrets and Variables.

  • Add secret GH_GITHUB_COM_TOKEN and paste the generated GitHub token.

The checks.yml workflow includes code to display your rate limits. See this template for a full example.

Artifact Upload/Download Errors#

If you are running self-hosted Git runners, keep in mind that git-action artifacts will upload/download to public GitHub. If your goal is to pass artifacts within a self-hosted runner, the best way is to save files to a shared space. See a discussion here.

If you want to upload/download artifacts to public GitHub using self-hosted runner then you must ensure that your CA certificates are used. These variables should be set in your .env file of your self-hosted runner.

NODE_EXTRA_CA_CERTS=/path/to/ca-certificates.pem # .crt and .pem are interchangeable
NODE_TLS_REJECT_UNAUTHORIZED=0 # disable CA checking for debugging purposes

Runner Debugging#

To enable debugging see here. The secret ACTIONS_RUNNER_DEBUG=true should be set, and debugging messaging will show up in the runner logs.

Contents