Skip to content
This repository was archived by the owner on Jul 29, 2019. It is now read-only.

Conversation

mojoaxel
Copy link
Member

This replaces the existing release docs with a new checklist for releases.

I hope this helps maintainers to release more often.

@mojoaxel mojoaxel added this to the Patch Release v4.20.1 milestone May 21, 2017
@mojoaxel mojoaxel changed the base branch from master to develop May 21, 2017 19:28
@mojoaxel mojoaxel requested a review from yotamberk May 21, 2017 19:29
Copy link
Contributor

@bradh bradh left a 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.

# Release Checklist

## Communication
- [ ] Create a new issue and copy&past this checklist into it (Yeah! First Step done!)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

past -> paste

- [ ] 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`
Copy link
Contributor

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)


## 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`)
Copy link
Contributor

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.
Copy link
Contributor

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.

- New Features start with `FEAT #issue:`

## Commit
- [ ] Commit the new version: `git commit -am "Release vX.X.Y"`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

vX.Y.Z

- [ ] 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"`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

vX.Y.Z

- [ ] 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`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

vX.Y.Z


## 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`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

vX.Y.Z+1

Copy link
Member

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"`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

vX.Y.Z+1

Copy link
Member

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`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

vX.Y.Z+1

Copy link
Member

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

Copy link
Contributor

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,

@mojoaxel mojoaxel self-assigned this May 22, 2017
yotamberk
yotamberk previously approved these changes Jun 17, 2017
@yotamberk
Copy link
Member

@bradh can you please approve this so I can merge the changes?

@yotamberk yotamberk merged commit 2eb4bbc into develop Jun 20, 2017
@mojoaxel mojoaxel deleted the releaseChecklist branch June 25, 2017 15:48
@mojoaxel
Copy link
Member Author

@bradh Sorry I simply forgot about this one!
@yotamberk Thanks for fixing my mistakes!!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants