Release Process
How a change gets from a merge request into a public release. Continues Contribute.
- The release of
civitas-core-deploymentis the public CIVITAS/CORE release. civitas-core-platformuses the same branches and flow. It releases first. The deployment then pins the platform image tags.- One branch per feature, fix or patch.
Versions
| Repository | Example | Scheme |
|---|---|---|
civitas-core-deployment | v2.0.3 | 2 = CIVITAS/CORE V2 · 0 = regular release · 3 = patch release |
civitas-core-platform | v1.3.2 | Independent. Not necessarily SemVer. |
Branches
| Branch | Purpose | Environment |
|---|---|---|
develop | Latest state. Developers test. Unstable. | Develop |
staging | QA by testers. No new changes during a sprint. | Staging |
release-2.0.x | Collects the patches of one patch release | — |
main | Released state. Each release is a tag. | — |
The platform builds floating image tags from develop and staging. Keel deploys them to the develop and staging environments. These environments are for internal testing, with full web access.
Development
- Make a feature branch from
develop. - Merge the feature branch into
develop. - At the end of each sprint, merge
developintostaging.
Regular release
- Platform: merge
stagingintomain. Tagmain, for examplev1.4.0. - Deployment: update the platform image tags to the new platform tag in a feature branch. Merge it through
developintostaging. - Deployment: merge
stagingintomain. Tagmain, for examplev2.1.0. This is the public release. - In both repositories, merge
mainintodevelop.
Patch release
The platform steps apply only when the patch needs platform changes. Sometimes only the deployment changes.
- Make
release-2.0.xfrommain. - Make one patch branch per fix from
release-2.0.x. Merge each intorelease-2.0.x. - Platform: merge
release-2.0.xintomain. Tagmain, for examplev1.4.1. - Deployment: update the platform image tags to the new platform tag in a patch branch. Merge it into
release-2.0.x. - Deployment: merge
release-2.0.xintomain. Tagmain, for examplev2.0.3. This is the public release. - In each changed repository, merge
mainintodevelop.
Roles
| Step | Who (GitLab role) |
|---|---|
Merge into main, tag | Owner |
| All other merges | Maintainer |
For each release, add update notes to Updating.