Update release instructions (#941)
This commit is contained in:
+14
-17
@@ -165,25 +165,22 @@ Checklist:
|
|||||||
|
|
||||||
### New release
|
### New release
|
||||||
|
|
||||||
1. Decide on the next version number. Use semver.
|
1. Decide on the next version number. Use semver. Review commits since last
|
||||||
2. Generate release notes using [`gh`][gh]. Example:
|
version to assess.
|
||||||
|
2. Tag release. For example:
|
||||||
```
|
```
|
||||||
$ gh api -X POST \
|
git checkout v2
|
||||||
-F tag_name='v2.0.0-beta.5' \
|
git pull
|
||||||
-F target_commitish='v2' \
|
git tag v2.2.0
|
||||||
-F previous_tag_name='v2.0.0-beta.4' \
|
git push --tags
|
||||||
--jq '.body' \
|
|
||||||
repos/pelletier/go-toml/releases/generate-notes
|
|
||||||
```
|
```
|
||||||
3. Look for "Other changes". That would indicate a pull request not labeled
|
3. CI automatically builds a draft Github release. Review it and edit as
|
||||||
properly. Tweak labels and pull request titles until changelog looks good for
|
necessary. Look for "Other changes". That would indicate a pull request not
|
||||||
users.
|
labeled properly. Tweak labels and pull request titles until changelog looks
|
||||||
4. [Draft new release][new-release].
|
good for users.
|
||||||
5. Fill tag and target with the same value used to generate the changelog.
|
4. Check "create discussion" box, in the "Releases" category.
|
||||||
6. Set title to the new tag value.
|
5. If new version is an alpha or beta only, check pre-release box.
|
||||||
7. Paste the generated changelog.
|
|
||||||
8. Check "create discussion", in the "Releases" category.
|
|
||||||
9. Check pre-release if new version is an alpha or beta.
|
|
||||||
|
|
||||||
[issues-tracker]: https://github.com/pelletier/go-toml/issues
|
[issues-tracker]: https://github.com/pelletier/go-toml/issues
|
||||||
[bug-report]: https://github.com/pelletier/go-toml/issues/new?template=bug_report.md
|
[bug-report]: https://github.com/pelletier/go-toml/issues/new?template=bug_report.md
|
||||||
|
|||||||
Reference in New Issue
Block a user