diff options
author | Evan Read <eread@gitlab.com> | 2023-02-28 18:43:49 +0300 |
---|---|---|
committer | Sarah German <sgerman@gitlab.com> | 2023-02-28 18:43:49 +0300 |
commit | 58aa7ba7a9523d45595f515562a1e9c1fd7b1ddd (patch) | |
tree | b4a56dfd7dcbbfda5a52b7467f035b3041b084e9 /doc | |
parent | 5e0d67406fbeb36fd9d123075120bb26e7bd6b94 (diff) |
Replace SKIP_MR option with DRY_RUN mode on redirects Rake task
Diffstat (limited to 'doc')
-rw-r--r-- | doc/raketasks.md | 15 |
1 files changed, 6 insertions, 9 deletions
diff --git a/doc/raketasks.md b/doc/raketasks.md index b30670b6..6cef7f2a 100644 --- a/doc/raketasks.md +++ b/doc/raketasks.md @@ -32,13 +32,16 @@ as seen in the "Local tasks" section of the [issue template](https://gitlab.com/ - Use `brew list` and see if `jq` is in the list. - If it is not installed, run `brew install jq`. -1. Optional. Run the rake task locally in your `gitlab-docs` directory in a "dry run" mode - that does not create any MRs: +1. Run the rake task locally in your `gitlab-docs` directory in a "dry run" mode that does not make any local changes or + create merge requests: ```shell - SKIP_MR=true bundle exec rake docs:clean_redirects + DRY_RUN=true bundle exec rake docs:clean_redirects ``` + Check that this runs succesfully before continuing. If it doesn't run successfully, correct any errors before + continuing. + 1. Run the rake task locally in your `gitlab-docs` directory. This command creates up to five merge requests: @@ -62,12 +65,6 @@ The task: Once all the MRs have been created, be sure to edit them to cross link between them and the recurring tasks issue. -To omit the automatic merge request creation: - -```shell -SKIP_MR=true bundle exec rake docs:clean_redirects -``` - ## Find pages that are not included in the global navigation Run this command to check for pages that are missing from the global navigation: |