2.1 KiB
2.1 KiB
name, about, title, labels, assignees
| name | about | title | labels | assignees |
|---|---|---|---|---|
| Release checklist | This is a checklist for maintainers to be used when creating a new release. | New release checklist for [version number] (maintainers only). |
You can see the action released in here. The version shows what was the last released version.
Checklist for a new release:
- Create a PR that bumps the version in
package.jsonand merge it- Read notes below to figure out which version to pick
- Make the commit read "Bump version to x.y.z"
- Once merged, visit the releases page
- Click Draft a new release
- Create a new tag by entering it in the drop down (see screenshot)
- Name the release (Use the version number if you want)
- Describe the release
- Use the button Generate Release Notes (see screenshot)
- Update the Full Changelog link to use the right tags (there's a minor bug)
- The first value is the last release; the second value is the tag that has not yet been created, thus, the link won't be working yet
- Once published, visit the marketplace to see that the release is showing up
- Update existing major tag (i.e. v1, v2 etc); Run the following commands
git checkout master && git pullgit tag -f v<Major Release Num>git push origin master --tags -f
DONE!! 🎉
Screenshot of UI to create tag as part of the release:
Screenshot of UI to generate release notes:
NOTES
We use semver (x.y.z) versioning. This basically means:
- x bump (breaking compatibility)
- z bump (bug fix/security)
- y bump for everything that does not fall on the other two categories