docs.gitlab.com release 15.10 (March, 2023)
Tasks for all releases
Documentation for handling the docs release is available.
Prerequisites:
- Make sure you have all the needed tools installed on your system.
Between the 17th and 20th of each month
-
Cross-link to the main MR for the release post: Release post - GitLab 15.10 (gitlab-com/www-gitlab-com!120791 - merged) • Christina Lohr • 15.10 -
On the day of the code cut-off (17th, but is sometimes moved earlier), share the following message in the #tw-team
channel:📣 I will run the docs release soon. Because we're close to the code cutoff, don't add new links to the docs navigation before I cut the release branch.Moving, renaming, or deleting entries is allowed. If you're unsure, please assign me to the nav MR.
-
Monitor the #releases
Slack channel. When the announcementThis is the candidate commit to be released on the 22nd
is made, it's time to begin. -
Create a stable branch and Docker image for the release: -
In the root path of the gitlab-docs
repository, update your local clone:make update
-
Run the Rake task to create the single version. For example, to create the 15.0 release branch and perform other tasks: ./bin/rake "release:single[15.0]"
A branch for the release is created, a new
15.0.Dockerfile
is created and automatically committed, and the new branch is pushed.After the branch is created, the
image:docs-single
job runs and creates a new Docker image tagged with the name of the stable branch (for example, see the 15.6 release pipeline). -
Share the following message in the #tw-team
channel:📣 The stable branch forgitlab-docs
was created. You can now make changes to docs navigation as usual. -
When the job finishes, confirm the Docker image has been created. Go to the registry
environment at https://gitlab.com/gitlab-org/gitlab-docs/-/environments/folders/registry and confirm the image is listed.
NOTE: The
compile_prod
orimage:docs-single
jobs may fail if stable branches have not been created for all the related projects. Some of the stable branches are created close to the 22nd, so you might need to run a new pipeline for the stable branch before the release. -
After the tasks above are complete, you don't need to do anything for a few days.
On the 22nd, or the first business day after
After the release post is live on the 22nd, or the next Monday morning if the release post happens on a weekend:
-
Verify that the pipeline for the stable branch (filter by branch) has passed and created a Docker image tagged with the release version. (If it fails, how do I fix it?) -
Create a docs.gitlab.com release merge request which updates the version dropdown menu for all online versions, updates the archives list, and adds the release to the Docker configuration. -
Deploy the versions:
-
Merge the docs release merge request. -
Go to the scheduled pipelines page and run the Build Docker images manually
pipeline. -
In the scheduled pipeline you just started, cancel the pipeline, and manually run the image:docs-latest
job, which builds the:latest
Docker image. -
When the job is complete, run the Build docs.gitlab.com every hour
scheduled pipeline.
-
-
After the deployment completes, open docs.gitlab.com
in a browser. Confirm both the latest version and the correct pre-release version are listed in the documentation version dropdown. -
Check all published versions of the docs to ensure they are visible and that their version menus have the latest versions. -
In this issue, create separate threads for the retrospective, and add items as they appear: ## :+1: What went well this release? ## :-1: What didn’t go well this release? ## :chart_with_upwards_trend: What can we improve going forward?
-
Mention @gl-docsteam
in a comment and invite them to read and participate in the retro threads.@gl-docsteam here's the docs release issue for XX.ZZ with some retro threads, per our [process](#on-the-22nd-or-the-first-business-day-after).
After the 22nd of each month:
-
Create a release issue for the next TW and assign it to them. -
Major releases only. Update OutdatedVersions.yml with the newly-outdated version. -
Improve this checklist. Continue moving steps from releases.md
to here until the issue template is the single source of truth and the documentation provides extra information.