Release Process

Versioning

We follow Semantic Versioning. In short, this means that the new version should reflect the types of changes that are about to be released.

summary from semver.org

MAJOR.MINOR.PATCH

• MAJOR version when you make incompatible API changes,
• MINOR version when you add functionality in a backwards compatible manner, and
• PATCH version when you make backwards compatible bug fixes.

When we release

We release gitlab-qa on an ad-hoc basis. There is no regularity to when we release, we just release
when we make a change - no matter the size of the change.

How-to

• Check if there is an open merge request to bump the version (to avoid creating a duplicate).
  • If there is one, update it if necessary.
  • If not, update lib/gitlab/qa/version.rb to an appropriate semantic version in a new merge request using the release template and title the MR like "Bump version to ".
  • Run bundle install to update the Gemfile.lock with the new version number of gitlab-qa.
• Merge the merge request.
• The new version should automatically be tagged and pushed to Rubygems by the gem-release job in the merge commit pipeline.
• Update the release notes for the newly created tag (https://gitlab.com/gitlab-org/gitlab-qa/-/tags):
  • Release notes: Copy the release notes from the merge request.

Note: The gem-release job uses:

• the GITLAB_API_TOKEN environment variable to authenticate against GitLab.com’s API in order to create the tag
• the GEM_HOST_API_KEY environment variable to authenticate against Rubygems.org’s API in order to release the gem

Post-release maintenance

Please note that gitlab-qa version in gitlab-org/gitlab project will be updated automatically by renovate-gitlab-bot. However, for live environment pipelines we need to specify the version in pipeline-common project manually. Remember to open an MR updating GITLAB_QA_VERSION value in base.gitlab-ci.yml shortly after the new version is released.

Flowchart

The flowchart below outlines a high-level overview of the gitlab-qa release process, along with post-release maintenance items required
to update the gitlab-qa version for our pipelines.

Key:

• Rectangles represent manual actions
• Hexagons represent automated actions

flowchart LR
    subgraph gitlab-qa
      A[Update lib/gitlab/qa/version.rb] --> B[Update Gemfile.lock]
      B --> C[Push branch]
      C --> D[Open MR with release template]
      D --> E[Review and merge]
      E --> F{{Tag created by gem-release job}}
      F --> G[Update tag release notes]
    end
    subgraph gitlab-org/gitlab
      H{{gitlab-renovate-bot checks for new gitlab-qa version}} --> I{{GitLab Dependency Bot opens MR}} 
      I --> J[Review and merge] 
      J --> K{{gitlab-qa version updated}}
    end
    subgraph pipeline-common
      L[Update GITLAB_QA_VERSION in ci/base.gitlab-ci.yml] --> M[Push branch]
      M --> N[Open MR]
      N --> O[Review and merge]
      O --> P[Follow pipeline-common release process]
    end
    gitlab-qa --> gitlab-org/gitlab & pipeline-common

    classDef linkNode color:blue,text-decoration:underline;
    class P linkNode;

    click P "https://gitlab.com/gitlab-org/quality/pipeline-common/-/tree/master#release-process"