Skip to content

Commit

Permalink
update release documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
thimios committed Nov 22, 2024
1 parent f4242cf commit 4844618
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions src/content/docs/development/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,8 +178,8 @@ percentage of the code and are not especially useful.
```shell
git push vX.X.X
```
Replace X.X.X with the version number. You can set the resulting release page to
"draft" using the Github API.
Replace X.X.X with the version number. The release will be created as a **draft**, it will not
be automatically published.
## Create the Release with Notes
Expand All @@ -189,6 +189,8 @@ percentage of the code and are not especially useful.
To manually generate release notes:
Create a deployment token on your [github developer settings](https://github.com/settings/tokens).
```shell
export GITHUB_TOKEN={YOUR DEPLOYMENT TOKEN ON GITHUB}
./build/run doc:release_notes -Dcurrent_tag=v3.4.0 -Doutfile=RELEASE_NOTES.md -Dtoken=$GITHUB_TOKEN
Expand Down

0 comments on commit 4844618

Please sign in to comment.