Release process

Open Organisatie makes use of quite a bit of Continuous Integration tooling to set up a full release process, all driven by the Git repository.

Github Actions

Our pipeline is mostly implemented on Github Actions:

Merges to the main branch are built on Github, where:

Releasing a new version can only be done by people with merge permissions to the main branch belonging to the Maykin organisation on Github.

Assuming a current version of 0.9.0:

Create a release branch

git checkout -b release/1.0.0

Update the changelog

Update CHANGELOG.rst in the root of the project, and make sure to commit the changes.

Editing files

Various files will contain the current version number. These files will have to be adjusted where applicable.

and commit:

git commit -am ":bookmark: Bump version to 1.0.0"

Push the changes and make a pull request.

Tag the release

Once the PR is merged to main, check out the main branch and tag it:

git checkout main
git pull
git tag 1.0.0

Tagging will ensure that a Docker image maykinmedia/open-organisatie:1.0.0 is published.