@@ -19,43 +19,68 @@ accordingly.
19192 . ** Create or update a [ changelog] [ ] entry** for {{% param version %}}.
2020 - The section should provide a brief summary of breaking changes using the
2121 section template at the end of the file.
22- - Ensure to remove the UNRELEASED note.
22+ - Ensure to remove the UNRELEASED note, if still present .
2323 - You'll create a new section for the next release in a later step.
2424
25253 . ** Update the release report blog post** for {{% param version %}}, if any.
2626 - Remove draft status.
27- - Update the date to today's date.
27+ - Set ` date ` (or ` lastmod ` if already published) to today's date.
2828
29294 . Run ` npm run fix ` .
3030
31- > Note: This might update the version in ` package.json ` via ` fix:version ` ,
31+ > [ !NOTE]
32+ >
33+ > This command might update the version in ` package.json ` via ` fix:version ` ,
3234 > but you can ignore this change since you'll be setting the version
3335 > explicitly in the next step.
3436
35375 . ** Update Docsy version** to {{% param version %}} using the following from a
36- (bash or zsh) terminal:
38+ (bash or zsh) terminal.
39+ - First set the ` VERSION ` variable; we use it throughout the steps below.
3740
38- ``` sh
39- VERSION={{% param version %}}
40- npm run set:version -- --version $VERSION
41- ```
41+ ``` sh
42+ VERSION={{% param version %}}
43+ ```
44+
45+ - Then run the ` set:version` script.
4246
43- This updates both ` version` keys in [package.json] and
44- [docsy.dev/hugo.yaml]. You can omit the argument to ` --version` when the
45- package is already a dev version of {{% param version %}}.
47+ Docsy is probably already at ` {{% param version %}}-dev` , so you can run:
48+
49+ ` ` ` sh
50+ npm run set:version
51+ ` ` `
52+
53+ Otherwise, set the version explicitly:
54+
55+ ` ` ` sh
56+ npm run set:version -- --version $VERSION
57+ ` ` `
58+
59+ Both forms update the ` version` related fields in [package.json][] and
60+ [docsy.dev/hugo.yaml][].
4661
47626. < a id=" ci-test-step" > Run ` npm run ci:test` < /a> , which runs ` ci:prepare` and
4863 more to ensure that, e.g., vendor assets and [go.mod] dependencies are
4964 up-to-date, etc.
5065
51- 7. ** Submit a PR with your changes** , using a title like " Release
52- {{% param version %}} preparation" . Use this command to create the PR via
53- the web interface:
66+ 7. ** Submit a PR with your changes** .
67+ - Commit any changes accumulated from the previous steps using this title:
5468
55- ` ` ` sh
56- gh pr create --web --title " Release $VERSION preparation" \
57- --body " - Contributes to #<ADD-RELEASE-PREP-ISSUE-HERE>"
58- ` ` `
69+ ` ` ` text
70+ Release {{% param version %}} preparation
71+ ` ` `
72+
73+ - Create a PR (with version-checks disabled) using the following command
74+ that will open a PR-creation page in your browser:
75+
76+ ` ` ` sh
77+ export SKIP_VERSION_CHECK=1
78+ gh pr create --web --title " Release $VERSION preparation" \
79+ --body " - Contributes to #<ADD-RELEASE-PREP-ISSUE-HERE>"
80+ ` ` `
81+
82+ - Use the web interface to fill in the PR details.
83+ - Submit the PR.
5984
60858. ** Test the PR** branch from selected sites, and push any required
6186 adjustments.
0 commit comments