Gitlab hero border pattern left svg Gitlab hero border pattern right svg

Release Tools

Introduction

Release Tools is a project maintained by the Delivery team, and used by Release Managers to perform releases of GitLab and its components. Release Tools works by running CI pipelines for specific purposes, such as tagging a new release or notifying merge requests about deployments. Some of these pipelines are triggered automatically (e.g. as part of a deploy), while others are triggered by users (e.g. using a chatops command).

GitLab.com project https://gitlab.com/gitlab-org/release-tools
ops.gitlab.net mirror https://ops.gitlab.net/gitlab-org/release/tools
Developer documentation https://gitlab.com/gitlab-org/release-tools/-/tree/master/doc

High-level overview of the release process

When Release Tools performs a release, it will roughly perform the following steps:

  1. Update one or more version files, such as the VERSION file in GitLab
  2. Update any additional files, such as Helm chart files
  3. Generate a changelog
  4. Commit the changes
  5. Create an annotated tag for these changes
  6. Push all this to the appropriate project

The exact steps vary a bit between projects. For example, for Gitaly release we also need to update some files in GitLab so it uses the correct Gitaly version.

Using Release Tools

Release Tools is only to be used by active Release Managers, and members of the Delivery team for testing purposes (e.g. when testing new functionality). Using Release Tools is primarily done through chatops and Slack. For example, to tag a self-managed release you'd run:

/chatops run release tag 42.0.0

This would then start the release tagging process of GitLab version 42.0.0.

For more information, refer to the release/docs project project.

Git is a trademark of Software Freedom Conservancy and our use of 'GitLab' is under license