A maintainer is a person who is responsible for maintaining the code repository.
- Find an open GitHub pull request.
- Check automatic tests have passed.
- Manually review code changes.
- Merge pull request.
- Code will be full tested on all deployment platforms using docker and latest development docker images will be updated.
GitHub workflow is provided to trigger releases on manual request using workflow_dispatch.
- Go to actions tab of this repository.
- Select the 'release' workflow and click 'Run workflow'. You will need to pick the release type (major, minor or patch).
- Code will be deployed. On succesfull deployment, 'main' is merged to 'prod'. Deployment creates a GitHub Release which includes libraries and samples for supported languages / OS's as well as python wheels for different versions. The python wheels are also published to pip. The message used for the release will be taken from the 'release.md' file in the root of the repository.
An installer can be created for the latest code developments using the 'build_installer.yml' github workflow. This can be triggered manually using workflow dispact on GitHub.com. This can be useful to make sure code changes are fully working before making a release.
- Go to actions tab of this repository.
- Select the 'build installer' workflow and click 'Run workflow'. You may select a branch to run this workflow on but it will default to main.
- Code will be built. On succesfull build, the installer will be available for download as an artifact in the workflow run summary.