diff options
author | Marcel Amirault <mamirault@gitlab.com> | 2022-06-28 12:10:51 +0300 |
---|---|---|
committer | Marcel Amirault <mamirault@gitlab.com> | 2022-06-28 12:10:51 +0300 |
commit | 21596f256cf1c101bd6f0418b9b151b1405bc7f7 (patch) | |
tree | 37a068966fa2dcee286374dc7878ee905c8bad4e | |
parent | d90c702cfc5277c7c118d8b7a23c7c355954b1f5 (diff) | |
parent | c37ebc57c636879d6d6b0c540394b1dc28c194be (diff) |
Merge branch 'eread/refine-docs-release-template' into 'main'
Refine docs release template and update release documentation
See merge request gitlab-org/gitlab-docs!2873
-rw-r--r-- | .gitlab/issue_templates/release.md | 7 | ||||
-rw-r--r-- | doc/releases.md | 7 |
2 files changed, 9 insertions, 5 deletions
diff --git a/.gitlab/issue_templates/release.md b/.gitlab/issue_templates/release.md index 2027de93..1919cea1 100644 --- a/.gitlab/issue_templates/release.md +++ b/.gitlab/issue_templates/release.md @@ -22,6 +22,7 @@ Documentation [for handling the docs release](https://gitlab.com/gitlab-org/gitl - [ ] Mark as `Draft` and do not merge. 1. [ ] [Update the three online versions](https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/doc/releases.md#update-dropdown-for-online-versions), so they display the new release on their version dropdown menus. + - [ ] Check the review app to make sure the menus display correctly. After the tasks above are complete, you don't need to do anything for a few days. @@ -35,9 +36,9 @@ After release post is live on the 22nd, or the next Monday morning if the releas - [ ] Merge the MRs for updates to the dropdown menus. - [ ] Merge the docs-release merge request. - [ ] Each merge triggers a new pipeline for each stable branch. Check - [the pipelines page](https://gitlab.com/gitlab-org/gitlab-docs/pipeline_schedules) + [the pipelines page](https://gitlab.com/gitlab-org/gitlab-docs/-/pipelines) and wait for all the stable branch pipelines to complete before proceeding. - - [ ] Go to the [scheduled pipelines page](https://gitlab.com/gitlab-org/gitlab-docs/pipeline_schedules) + - [ ] Go to the [scheduled pipelines page](https://gitlab.com/gitlab-org/gitlab-docs/-/pipeline_schedules) and run the Build Docker images weekly pipeline. - [ ] In the scheduled pipeline you just started, manually run the `image:docs-latest` job that builds the `:latest` Docker image. @@ -58,7 +59,7 @@ After the 22nd of each month: 1. [ ] Create a release issue for the [next TW](https://about.gitlab.com/handbook/marketing/blog/release-posts/managers/) and assign it to them. -1. [ ] *Major releases only.* Update +1. [ ] **Major releases only.** Update [OutdatedVersions.yml](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/OutdatedVersions.yml) with the newly-outdated version. 1. [ ] Improve this checklist. Continue moving steps from diff --git a/doc/releases.md b/doc/releases.md index d2ad4066..962118f6 100644 --- a/doc/releases.md +++ b/doc/releases.md @@ -37,6 +37,9 @@ To minimize problems during the documentation release process, use the following - Complete the preparation steps between the 17th and the 20th of the month. **All** of the following steps must be completed successfully before proceeding with the publication steps: + 1. If an issue was not already created for you by the TW that handled the last release, + [create an issue for the release](https://gitlab.com/gitlab-org/gitlab-docs/-/issues/new?issuable_template=release) + to track your progress and ensure completeness. 1. [Create a stable branch and Docker image](#create-stable-branch-and-docker-image-for-release) for the new version. 1. [Create a release merge request](#create-release-merge-request) for the new version, which @@ -186,9 +189,9 @@ The merge requests for the dropdowns should now all be merged into their respect 1. Merge all of the [dropdown merge requests](#update-dropdown-for-online-versions). 1. Merge the [release merge request](#create-release-merge-request). 1. Each merge triggers a new pipeline for each stable branch. - Check the [pipelines page](https://gitlab.com/gitlab-org/gitlab-docs/pipelines) and wait + Check the [pipelines page](https://gitlab.com/gitlab-org/gitlab-docs/-/pipelines) and wait for all the stable branch pipelines to complete. -1. Go to the [scheduled pipelines page](https://gitlab.com/gitlab-org/gitlab-docs/pipeline_schedules) +1. Go to the [scheduled pipelines page](https://gitlab.com/gitlab-org/gitlab-docs/-/pipeline_schedules) and run the `Build docker images weekly` pipeline. 1. In the scheduled pipeline you just started, manually run the **image:docs-latest** job that builds the `:latest` Docker image. 1. When the pipeline is complete, run the `Build docs.gitlab.com every 4 hours` scheduled pipeline to deploy all new versions to the public documentation site. |