diff options
| -rw-r--r-- | .gitlab/merge_request_templates/Release.md | 28 | ||||
| -rw-r--r-- | doc/releases.md | 24 |
2 files changed, 22 insertions, 30 deletions
diff --git a/.gitlab/merge_request_templates/Release.md b/.gitlab/merge_request_templates/Release.md index 3dff21d9..dc2fb6e4 100644 --- a/.gitlab/merge_request_templates/Release.md +++ b/.gitlab/merge_request_templates/Release.md @@ -1,29 +1,5 @@ -[> How to](https://about.gitlab.com/handbook/engineering/ux/technical-writing/workflow/#monthly-documentation-releases) +Follow the process in [Monthly documentation releases](https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/doc/releases.md). -## During release - -1. [ ] Push the new version which will create a Docker image with the stable version: - ```sh - bundle exec rake "release:single[X.Y]" - ``` -1. [ ] Edit `content/_data/versions.yaml` and `Dockerfile.master` and rotate the versions. - -## Before merge - -On the 22nd, before merging this MR: - -1. [ ] Bump the dropdown versions for all online versions: - ```sh - bundle exec rake release:dropdowns - ``` - - This creates all the [needed merge requests](https://gitlab.com/gitlab-org/gitlab-docs/-/merge_requests?label_name[]=release). -1. [ ] Check that all of the above MRs' pipelines pass and merge them. - Once all above MRs are merged, check the newly-created pipelines of the - respective versions https://gitlab.com/gitlab-org/gitlab-docs/pipelines. - Once they are green, it's time to merge this MR. -1. [ ] Manually run the ["Build docker images weekly" scheduled pipeline](https://gitlab.com/gitlab-org/gitlab-docs/pipeline_schedules). - This is needed so that the `image:docs-latest` image is built that will - contain all the updated versions. +You can also copy its contents here and change the bullet points into checkboxes. /label ~release diff --git a/doc/releases.md b/doc/releases.md index 45949cef..89fe54db 100644 --- a/doc/releases.md +++ b/doc/releases.md @@ -49,7 +49,7 @@ To minimize problems during the documentation release process, use the following 1. [Update the three online versions](#update-dropdown-for-online-versions), so that they display the new release on their version dropdown menus. -- On the 22nd of the month: +- On the 22nd of the month, after the release post is live: [Merge the release merge requests and run the necessary Docker image builds](#merge-merge-requests-and-run-docker-image-builds). @@ -77,16 +77,30 @@ For example, see [the 13.9 release pipeline](https://gitlab.com/gitlab-org/gitla If the pipeline fails, the new Docker image is not created and so not added to the registry. -Optionally, you can test locally by: +### Optional. Test locally -1. Building the image and running it. For example, for GitLab 13.9 documentation: +Prerequisite: + +- Install Docker. To verify, run `which docker`. + +1. Build the image and run it. For example, for GitLab 13.9 documentation: ```shell docker build -t docs:13.9 -f Dockerfile.13.9 . docker run -it --rm -p 4000:4000 docs:13.9 ``` -1. Visiting `http://localhost:4000/13.9` to see if everything works correctly. + If you get a permission error, try running the commands prefixed with `sudo`. + + If you're informed that the Docker daemon isn't running, start it manually: + + - (MacOS) `dockerd` ([read more](https://docs.docker.com/config/daemon/#start-the-daemon-manually)). + - (Linux) `sudo systemctl start docker` ([read more](https://docs.docker.com/config/daemon/systemd/#start-manually)). + +1. Visit `http://localhost:4000/13.9` to see if everything works correctly. +1. Stop the Docker container: + 1. Identify the container's ID with `docker container ls`. + 1. Run `docker stop <container ID>`. ## Create release merge request @@ -215,6 +229,8 @@ The steps should be updated when we move to the next major release (15.0). ## Merge merge requests and run Docker image builds +_Do this after the release post is live._ + The merge requests for the dropdowns should now all be merged into their respective stable branches. 1. Check the [pipelines page](https://gitlab.com/gitlab-org/gitlab-docs/pipelines) |