-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Release checklist #3084
Release checklist #3084
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. Just minor editorial stuff.
misc/RELEASE_CHECKLIST_TEMPLATE.md
Outdated
# Release Checklist | ||
|
||
## Communication | ||
- [ ] Create a new issue and copy&past this checklist into it (Yeah! First Step done!) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
past -> paste
misc/RELEASE_CHECKLIST_TEMPLATE.md
Outdated
- [ ] Talk to the team: Who should make the release? | ||
- [ ] Announce a "Code-Freeze". No new Pull-Request until the release is done! | ||
- [ ] Checkout if we have MAJOR or MINOR changes. If not we do a PATCH release. | ||
- [ ] The new version will be: `vX.X.Y` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Strictly speaking it should be vX.Y.Z
(so major and minor versions can be different)
misc/RELEASE_CHECKLIST_TEMPLATE.md
Outdated
|
||
## Update to the newest version | ||
- [ ] Update to the current version: `git checkout develop && git pull`. | ||
- [ ] Create a new release branch. (`git checkout -b vX.X.Y develop`) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
vX.Y.Z
(*THIS IS A LOT OF WORK! WE SHOULD TRY TO automate this in the future!!*) | ||
|
||
- [ ] Get all commits since the last release: ```git log `git describe --tags --abbrev=0`..HEAD --oneline > .commits.tmp``` | ||
- [ ] Open ".commity.tmp". and remove all commit before the last release. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
.commits.tmp
(also "all commit" -> "all commits"
Seems like there should be a way to get git to do this part, optimisation for later.
misc/RELEASE_CHECKLIST_TEMPLATE.md
Outdated
- New Features start with `FEAT #issue:` | ||
|
||
## Commit | ||
- [ ] Commit the new version: `git commit -am "Release vX.X.Y"` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
vX.Y.Z
misc/RELEASE_CHECKLIST_TEMPLATE.md
Outdated
- [ ] Check if there are new or updated examples, and update the gallery screenshots accordingly. | ||
- [ ] Update the library version number in the `index.html` page. | ||
- [ ] Update the CDN links at the download section of index.html AND the CDN link at the top. (search-replace all!!) | ||
- [ ] Commit the changes: `git add -A && git commit -m "updates for vX.X.Y"` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
vX.Y.Z
misc/RELEASE_CHECKLIST_TEMPLATE.md
Outdated
- [ ] Update the library version number in the `index.html` page. | ||
- [ ] Update the CDN links at the download section of index.html AND the CDN link at the top. (search-replace all!!) | ||
- [ ] Commit the changes: `git add -A && git commit -m "updates for vX.X.Y"` | ||
- [ ] Push the changes `git push --set-upstream origin gh-pages_vX.X.Y` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
vX.Y.Z
misc/RELEASE_CHECKLIST_TEMPLATE.md
Outdated
|
||
## Prepare next version | ||
- [ ] Switch to the "develop" branch: `git checkout develop`. | ||
- [ ] Change version numbers in "package.json" to a snapshot version `X.X.Z-SNAPSHOT`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
vX.Y.Z+1
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No... This should stay SNAPSHOT
until next version is updated
## Prepare next version | ||
- [ ] Switch to the "develop" branch: `git checkout develop`. | ||
- [ ] Change version numbers in "package.json" to a snapshot version `X.X.Z-SNAPSHOT`. | ||
- [ ] Commit and push: `git commit -am "changed version to vX.X.Z-SNAPSHOT"` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
vX.Y.Z+1
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No... This should stay SNAPSHOT
until next version is updated
- [ ] Switch to the "develop" branch: `git checkout develop`. | ||
- [ ] Change version numbers in "package.json" to a snapshot version `X.X.Z-SNAPSHOT`. | ||
- [ ] Commit and push: `git commit -am "changed version to vX.X.Z-SNAPSHOT"` | ||
- [ ] Create new tag: `git tag vX.X.Z-SNAPSHOT`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
vX.Y.Z+1
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No... This should stay SNAPSHOT
until next version is updated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@yotamberk Approved the changes. I meant that the version after vX.Y.Z should be vX.Y.Z+1-SNAPSHOT,
@bradh can you please approve this so I can merge the changes? |
@bradh Sorry I simply forgot about this one! |
This replaces the existing release docs with a new checklist for releases.
I hope this helps maintainers to release more often.