Skip to main content
Version: V2-Next

Release Process

How a change gets from a merge request into a public release. Continues Contribute.

  • The release of civitas-core-deployment is the public CIVITAS/CORE release.
  • civitas-core-platform uses the same branches and flow. It releases first. The deployment then pins the platform image tags.
  • One branch per feature, fix or patch.

Versions​

RepositoryExampleScheme
civitas-core-deploymentv2.0.32 = CIVITAS/CORE V2 · 0 = regular release · 3 = patch release
civitas-core-platformv1.3.2Independent. Not necessarily SemVer.

Branches​

BranchPurposeEnvironment
developLatest state. Developers test. Unstable.Develop
stagingQA by testers. No new changes during a sprint.Staging
release-2.0.xCollects the patches of one patch release—
mainReleased 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​

  1. Make a feature branch from develop.
  2. Merge the feature branch into develop.
  3. At the end of each sprint, merge develop into staging.

Regular release​

  1. Platform: merge staging into main. Tag main, for example v1.4.0.
  2. Deployment: update the platform image tags to the new platform tag in a feature branch. Merge it through develop into staging.
  3. Deployment: merge staging into main. Tag main, for example v2.1.0. This is the public release.
  4. In both repositories, merge main into develop.

Patch release​

The platform steps apply only when the patch needs platform changes. Sometimes only the deployment changes.

  1. Make release-2.0.x from main.
  2. Make one patch branch per fix from release-2.0.x. Merge each into release-2.0.x.
  3. Platform: merge release-2.0.x into main. Tag main, for example v1.4.1.
  4. Deployment: update the platform image tags to the new platform tag in a patch branch. Merge it into release-2.0.x.
  5. Deployment: merge release-2.0.x into main. Tag main, for example v2.0.3. This is the public release.
  6. In each changed repository, merge main into develop.

Roles​

StepWho (GitLab role)
Merge into main, tagOwner
All other mergesMaintainer

For each release, add update notes to Updating.