From 8d5df497961f4cab5a6f7e5d2dbc659e5dcceef6 Mon Sep 17 00:00:00 2001 From: hugovk Date: Mon, 11 May 2015 13:53:40 +0300 Subject: [PATCH] Add release checklist --- README.md | 2 +- RELEASING.md | 28 ++++++++++++++++++++++++++++ 2 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 RELEASING.md diff --git a/README.md b/README.md index a683d8c..7032718 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,6 @@ fino [![Coverage Status](https://coveralls.io/repos/hugovk/fino/badge.png?branch=master)](https://coveralls.io/r/hugovk/fino?branch=master) [![Code Health](https://landscape.io/github/hugovk/fino/master/landscape.svg)](https://landscape.io/github/hugovk/fino/master) -Given an integer, output the Finnish word for that number. +Output the Finnish word for a given integer. * Used by [hugovk/everyfinnishno](https://github.com/hugovk/everyfinnishno) to tweet [@EveryFinnishNo](https://twitter.com/EveryFinnishNo). diff --git a/RELEASING.md b/RELEASING.md new file mode 100644 index 0000000..fe78496 --- /dev/null +++ b/RELEASING.md @@ -0,0 +1,28 @@ +# Release Checklist + +* [ ] Get master to the appropriate code release state. [Travis CI](https://travis-ci.org/hugovk/fino) should be running cleanly for all merges to master. +* [ ] Update version in `setup.py` and commit: +```bash +git checkout master +edit setup.py +git add setup.py +git commit -m "Release 0.3.0" +``` +* [ ] Tag the last commit with the version number: +```bash +git tag -a 0.3.0 -m "Release 0.3.0" +``` +* [ ] Release on PyPI: +```bash +python setup.py register +python setup.py sdist --format=gztar upload +``` +* [ ] Push: `git push` +* [ ] Push tags: `git push --tags` +* [ ] Create new GitHub release: https://github.com/hugovk/fino/releases/new +* [ ] Update develop branch from master: +```bash +git checkout develop +git merge master --ff-only +git push +```