@@ -80,40 +80,56 @@ truth for what the changelog and release blog must cover.
8080## Publishing a release
8181
8282These notes are WIP for creating a ** release** from a local copy of the repo.
83- These instructions assume the release is {{% param version %}}, if not adjust
84- accordingly.
83+ These instructions assume the release is:
84+
85+ - ** {{% dev-version final %}}**
86+
87+ If not adjust accordingly.
8588
8689> [ !IMPORTANT]
8790>
8891> Before creating a release, do a [ release-prep audit] ( #release-prep-audit ) and
8992> use it to drive the changelog and release-blog updates in the next two steps.
9093
91941 . ** Change directory** to your local Docsy repo.
95+ - Expecting final adjustments as you prepare for the release? Create a
96+ branch to work from. For example:
97+
98+ ``` sh
99+ git checkout -b release-{{% dev-version final %}}-prep
100+ # Or you have a local create-branch alias:
101+ gcb release-{{% dev-version final %}}-prep
102+ ```
103+
104+ - Serve the site and continue working through these steps from the served
105+ version of these notes.
92106
93- 2 . ** Create or update a [ changelog] [ ] entry** for {{% param version %}}.
107+ 2. ** Create or update a [changelog][] entry** for {{% dev- version final %}}.
94108 - This step is driven by the [release-prep audit](# release-prep-audit).
95109 - The section should provide a brief summary of breaking changes using the
96110 section template at the end of the file.
97111 - Ensure to remove the UNRELEASED note, if still present.
98112 - You' ll create a new section for the next release in a later step.
99113
100- 3 . ** Update the release report blog post** for {{% param version %}}, if any.
114+ 3. **Update the release report blog post** for {{% dev-version final %}}, if
115+ any.
101116 - Remove draft status.
102117 - Set `date` (or `lastmod` if already published) to today' s date.
103118
1041194. Run ` npm run fix` .
105120
106- 5 . ** Update Docsy version** to {{% param version %}} using the following from a
107- (bash or zsh) terminal.
121+ 5. ** Update Docsy version** to {{% dev- version final %}} using the following
122+ from a (bash or zsh) terminal.
108123 - First set the ` VERSION` variable; we use it throughout the steps below.
109124
110125 ` ` ` sh
111- VERSION={{% param version %}}
126+ VERSION={{% dev- version final %}}
112127 ` ` `
113128
114129 - Then run the ` set:version` script.
115130
116- Docsy is probably already at ` {{% param version %}}-dev` , so you can run:
131+ Docsy is probably already at ` {{% dev-version final %}}-dev` , so you can
132+ run:
117133
118134 ` ` ` sh
119135 npm run set:version
@@ -143,7 +159,7 @@ accordingly.
143159 - Commit any changes accumulated from the previous steps using this title:
144160
145161 ` ` ` text
146- Release {{% param version %}} preparation
162+ Release {{% param tdVersion.latest %}} preparation
147163 ` ` `
148164
149165 - Create a PR (with version-checks disabled) using the following command
@@ -177,14 +193,14 @@ accordingly.
177193
17819412. ** Ensure** that you' re:
179195 - On the target `$BASE` branch
180- - At the commit that you want to tag as {{% param version %}}
196+ - At the commit that you want to tag as {{% param tdVersion.latest %}}
181197
182- 13. **Create the new tag** for {{% param version %}}.
198+ 13. **Create the new tag** for {{% param tdVersion.latest %}}.
183199 - Set the REL variable to the release version or use the `VERSION` variable
184200 if you set it in the previous step.
185201
186202 ```sh
187- REL=v${VERSION:-{{% param version %}}}
203+ REL=v${VERSION:-{{% param tdVersion.latest %}}}
188204 echo "REL=$REL"
189205 ```
190206
@@ -253,10 +269,10 @@ accordingly.
253269
254270 ` ` ` console
255271 $ git push-all-remotes $REL
256- + git push origin {{% param version %}}
257- * [new tag] {{% param version %}} -> {{% param version %}}
258- + git push upstream {{% param version %}}
259- * [new tag] {{% param version %}} -> {{% param version %}}
272+ + git push origin {{% param tdVersion.latest %}}
273+ * [new tag] {{% param tdVersion.latest %}} -> {{% param tdVersion.latest %}}
274+ + git push upstream {{% param tdVersion.latest %}}
275+ * [new tag] {{% param tdVersion.latest %}} -> {{% param tdVersion.latest %}}
260276 ...
261277 ` ` `
262278
@@ -310,15 +326,15 @@ accordingly.
310326 been updated to the new release.
311327
31232817. **[Draft a new release][]** using GitHub web; fill in the fields as follows:
313- - Visit [tags][] to find the new release tag {{% param version %}}.
329+ - Visit [tags][] to find the new release tag {{% param tdVersion.latest %}}.
314330
315- - Select Create a new release from the {{% param version %}} tag dropdown
316- menu
331+ - Select Create a new release from the {{% param tdVersion.latest %}} tag
332+ dropdown menu
317333
318334 - **Release title**: use the release version.
319335
320336 ```text
321- {{% param version %}}
337+ {{% param tdVersion.latest %}}
322338 ```
323339
324340 - Click **Generate release notes** to get the release details inserted into
@@ -395,7 +411,7 @@ before any further changes are merged into the `main` branch:
3954113. **Submit a PR with your changes**, using a title like:
396412
397413 ```text
398- Set version to {{% param version %}}
414+ Set version to {{% param tdVersion.latest %}}
399415 ```
400416
4014174. **Get PR approved and merged**.
0 commit comments