diff options
author | Evan Read <eread@gitlab.com> | 2022-06-20 05:23:27 +0300 |
---|---|---|
committer | Marcel Amirault <mamirault@gitlab.com> | 2022-06-20 05:23:27 +0300 |
commit | d0158ca93d5a2577430ee86d28faf3b767563d38 (patch) | |
tree | d1031328f8c13f35997c42da610cde144ee97ef5 | |
parent | ce4f3c7885f68ac6516f50cd0af55c4c67b38b68 (diff) |
Improve documentation and console output when cutting docs releases
-rw-r--r-- | Rakefile | 4 | ||||
-rw-r--r-- | doc/releases.md | 10 |
2 files changed, 4 insertions, 10 deletions
@@ -129,8 +129,8 @@ namespace :release do `git add .gitlab-ci.yml #{version}.Dockerfile` `git commit -m 'Release cut #{version}'` - puts "\n#{COLOR_CODE_GREEN}INFO: Created new Dockerfile: #{dockerfile}.#{COLOR_CODE_RESET}" - puts "#{COLOR_CODE_GREEN}INFO: You can now add, commit and push the new branch: git push origin #{version}.#{COLOR_CODE_RESET}" + puts "\n#{COLOR_CODE_GREEN}INFO: Created new Dockerfile:#{COLOR_CODE_RESET} #{dockerfile}." + puts "#{COLOR_CODE_GREEN}INFO: To push the new branch, run:#{COLOR_CODE_RESET} git push origin #{version}." end desc 'Creates merge requests to update the dropdowns in all online versions' diff --git a/doc/releases.md b/doc/releases.md index b353d83b..d2ad4066 100644 --- a/doc/releases.md +++ b/doc/releases.md @@ -68,8 +68,7 @@ To create a stable branch of the `gitlab-docs` project and a Docker image for th 1. Update your local clone: ```shell - git stash -u - git fetch origin && git rebase origin/main + make update ``` 1. Run the Rake task to create the single version. For example, to create the 15.0 release branch @@ -130,20 +129,15 @@ To create the release merge request for the release: 1. Update your local clone: ```shell - git stash -u - git fetch origin && git rebase origin/main + make update ``` 1. Create a branch `release-X-Y`. For example: ```shell - git checkout main git checkout -b release-15-0 ``` - Confirm the branch has been created. Go to <https://gitlab.com/gitlab-org/gitlab-docs/-/branches/active> - and verify the branch is listed. - 1. Edit `content/_data/versions.yaml` and update the lists of versions to reflect the new release: - Add the latest version to the `online:` section. |