diff --git a/src/content/docs/development/release.md b/src/content/docs/development/release.md index 8faa2e5..01fb5d0 100644 --- a/src/content/docs/development/release.md +++ b/src/content/docs/development/release.md @@ -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 @@ -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