Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documenting release procedure #68

Merged
merged 1 commit into from
Dec 7, 2015
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Release procedure for shub

The Travis build is configured to release shub to PyPI whenever
a new tag is committed.

The steps to do a release are:

1) Install [bumpversion](https://pypi.python.org/pypi/bumpversion)

2) Make sure you're in the tip of master, and then run:

bumpversion VERSION_PART

In place of VERSION_PART, use one of `patch`, `minor` or `major`, meaning the
part of the version number to be updated.

This will create a new commit and tag updating the version number.

3) Push the changes and the new tag to trigger the release:

git push && git push --tags

4) Once the build finishes, run `pip install shub` in a temporary virtualenv
and make sure it's installing the latest version.

5) Update the release information in:

https://github.com/scrapinghub/shub/releases