RELEASING.md

gratipay-badge release runbook

gratipay-badge is a complex beast due to the image coming directly from the repository. As a result, it is necessary to document the steps to make sure nothing is missed.

In the future, we hope to make the release a 1 step process:

#6

Dependencies

Currently, we require you have git and node>=0.8.0 installed.

Releasing

1. Update README.md to point to latest semver for all URLs. This has been automated with update-semver.sh

   ./update-semver.sh {{semver}}

2. Add update notes to CHANGELOG.md

3. Stage changes

   git add -p

4. Commit to git, tag git, push commit, push tags, update/create semver branches (e.g. 2.x.x for 2.0.x), push semver branches via foundry.

   # If we haven't installed `foundry` and our plugins, do so
   if test -x node_modules/.bin/foundry; then
       npm install
   fi
   
   # Release via foundry
   ./node_modules/.bin/foundry release {{semver}}

   1. In the background, foundry is performing the following steps

   2. Commit changes with message "Release {{semver}}"

      git commit -m "Release {{semver}}"

   3. git tag with version

      git tag {{semver}}

   4. Publish master branch

      git push origin master

   5. Publish tag

      git push --tags

   6. Overwrite variable minor semver branch (e.g. 2.0.0 -> 2.x.x)

      git checkout -B {{variable-minor-semver}}

   7. Publish branch

      git push origin {{variable-minor-semver}}

   8. Overwrite variable patch semver branch (e.g. 2.0.0 -> 2.0.x)

      git checkout -B {{variable-patch-semver}}

   9. Publish branch

      git push origin {{variable-patch-semver}}

   10. Return to master

       git checkout master