Github.md

Github Actions

Templates for Github Actions workflows I have used for Continuous Testing and Integration can be found in the .github/workflows directory.

Run Unit Tests and Code Coverage

This workflow has the following jobs:

• run unit tests using pytest
• run code coverage using coverage and generating a report published in the PR
• update the code coverage badge in the README.md file

If using this template, you will need to perform the following steps:

• In github.com:
  • add a secret GIST_SECRET with read and write access to gists in your repository settings
  • add a secret to dependabot GIST_SECRET with read and write access to gists in your repository settings
  • create a public gist with the code coverage badge
  • add Read and Write permissions under the repository settings, Actions section, to the GITHUB_TOKEN secret (allows publishing the coverage report in the PR)
• In the workflow file:
  • update the GIST_ID and filename to match the gist you created
• In the README.md:
  • update the code coverage badge URL to contain the url to the gist you created

Useful links:

• Github Action - Dynamic Badges

Publish Docker Image

This workflow has the following jobs:

• build the docker image
• publish the docker image to the Github Container Registry and Docker Hub

If using this template, you will need to perform the following steps:

• In dockerhub.com:
  • create a token with read and write access to your repositories
• In github.com:
  • add a secret DOCKERHUB_USERNAME with your Docker Hub username
  • add a secret DOCKERHUB_TOKEN with your Docker Hub token
• In the workflow file:
  • update the image_name to match the name of your image
  • update the dockerfile to match the name of your Dockerfile
  • validate the tags being used