GitHub CI/CD practice

Sources for practice lecture about containers used in NSWI026 MFF UK and SEPA4M33SEP, FEL CVUT. This should be a simple example for CI/CD, it's not recommended for a production usage.

Tasks

1. Take a look on basic usage of GitHub workflows.

   • https://web.archive.org/web/20240119131452/https://docs.github.com/en/actions/examples/using-scripts-to-test-your-code-on-a-runner
   • https://docs.github.com/en/actions/quickstart

2. Take a look on script in task_a. Try it locally:

   • (Optional) Prepare an env python3 -m venv venv, activate it source venv/bin/activate and install dependencies pip3 install -r requirements.txt.
   • (Optional) Try to execute tests pytest task_a.py.

On push events

3. Make one test failing and fill a GitHub workflow to execute tests.
   • Change .github/workflows/task-a-cd.yml and push it to your GitHub.
4. Try to speed up testing using cache on one of following methods.
   • Using cache: 'pip' in actions/setup-python
   • Using actions/cache
5. Generate an html report for PyTest with --html=report.html and upload it to GitHub using actions/upload-artifact
6. Run tests on multiple operating systems and Python versions using matrix option.

   runs-on: ${{ matrix.os }}
   strategy:
     matrix:
       os: [ubuntu-latest, macos-latest, windows-latest]
       python-version: ["3.10", "3.11", "pypy3.10"]
       exclude:
         - os: macos-latest
           python-version: "3.10"
         - os: windows-latest
           python-version: "3.10"

   • Don't forget to use matrix value ${{ matrix.os }} in jobs.test.runs-on and ${{ matrix.python-version }} in jobs.test.steps[2].with.python-version
   • Rename artifact to Report-${{ matrix.os }}-${{ matrix.python-version }} get rid of name conflicts
   • Take a look on reports, check Platform section if everything works as expected

On pull request

7. Change "task-a-cd.yml" to task-a-ci.yml and change to be executed on a pull-request, take a look on pull_request.
8. Run this pull request only on changes tu folder task_a, take a look on paths.

On manual event

9. Try a manual workflow "task-b manual".
10. Build a docker image, using docker/build-push-action, you could reuse following lines
    • Create an workflow input tag for image tag
    • Tag image like ghcr.io/${{ github.repository }}:${{ inputs.tag }}
11. Build a dependent job test
    • It should depend on docker job
    • It should run docker container from previous step as service container
    • Call curl 127.0.0.1:8080/index.html to fetch index.html

Build our flight-log

12. Get own repository for FlightLog
    • CI - Test application on pull-request
      • Java - mvn test
      • .NET - https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-net#building-and-testing-your-code
    • CD - Build a docker image on push to master / develop
      • Java - https://spring.io/guides/gs/spring-boot-docker
      • .NET - https://learn.microsoft.com/en-us/dotnet/core/docker/build-container