Skip to content

Commit 7c1458f

Browse files
committed
update release documentation
1 parent f4242cf commit 7c1458f

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

src/content/docs/development/release.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -178,8 +178,8 @@ percentage of the code and are not especially useful.
178178
```shell
179179
git push vX.X.X
180180
```
181-
Replace X.X.X with the version number. You can set the resulting release page to
182-
"draft" using the Github API.
181+
Replace X.X.X with the version number. The release will be created as a **draft**, it will not
182+
be automatically published.
183183
184184
## Create the Release with Notes
185185
@@ -189,9 +189,11 @@ percentage of the code and are not especially useful.
189189
190190
To manually generate release notes:
191191
192+
Create a deployment token on your [github developer settings](https://github.com/settings/tokens).
193+
192194
```shell
193195
export GITHUB_TOKEN={YOUR DEPLOYMENT TOKEN ON GITHUB}
194-
./build/run doc:release_notes -Dcurrent_tag=v3.4.0 -Doutfile=RELEASE_NOTES.md -Dtoken=$GITHUB_TOKEN
196+
./build/run doc:release_notes -Dcurrent_tag=v3.4.0 -Doutfile=RELEASE_NOTES.md -Dtoken=$GITHUB_TOKEN -Dgh_user={your_github_username}
195197
```
196198
197199
#### Edit Release Page As Neccessary

0 commit comments

Comments
 (0)