Skip to content

Latest commit

 

History

History
54 lines (42 loc) · 2.23 KB

ReleaseHowto.md

File metadata and controls

54 lines (42 loc) · 2.23 KB
Raw

How to release

This is a quick howto so I don't forget how to squash commits and push code up to github when it's release-time.

Entry Situation

Remotes are setup like this:

github	git@github.com:skalio/teambeamjs.git (fetch)
github	git@github.com:skalio/teambeamjs.git (push)
origin	git@git.skalio.net:teambeamjs.git (fetch)
origin	git@git.skalio.net:teambeamjs.git (push)

The following remote branches exist:

  • origin/master: Where development is done
  • github/master: Releases to the public

Additionally, local (feature) branches may exist.

WiP

While fixing stuff and and adding new functionality, work in local branch master, tracking origin/master. Commit often, referencing trac tickets in the commit messages, and push to origin/master.

Preparing a release

Once all work for a release is done, perform these steps:

  1. README.md: update documentation as necessary; update revision history at the bottom; commit
  2. package.json: update version number; commit "Lifting version to v0.x.y"
  3. not sure about this: tag the commit: git tag -a v0.x.y -m "version 0.x.y"
  4. push everything up to origin: git push origin master v0.x.y without the tag I think

Squashing commits

The github releases don't need to show the individual WiP commit history, so we squash them:

  1. Go to detached HEAD state at tag of previous release: git checkout v0.x.x
  2. Create a local release branch: git checkout -b release
  3. Make sure we are up to date on github at HEAD of master branch: git fetch github master
  4. Merge origin master to onto this position, making sure, origin master is favoured: git merge --squash -X theirs origin/master
  5. Combine all changes into a single commit: git commit -a -m "Lifting version to v0.y.y" -m ""
  6. Confirm that the result is no different from master: git diff origin master shall show nothing
  7. Tag the commit: git tag -a v0.y.y -m "version 0.y.y"

Release to Github

  1. Push everything up, but make sure it ends up in github's master branch: git push --force github release:master v0.y.y

Github should now show a single new commit as well as a new release.

Back to work

  1. switch back to master: git checkout master
  2. delete the release branch again: git branch -D release