Skip to content

Update release.md #200

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 26, 2024
Merged

Update release.md #200

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions src/content/docs/development/release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,8 +178,7 @@ 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 +188,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