Skip to content

Commit

Permalink
Merge pull request #140 from monzo/release-docs
Browse files Browse the repository at this point in the history
Adds basic doc for the release process
  • Loading branch information
Chris authored Sep 9, 2019
2 parents 2a2ec32 + 56fe3ba commit b6d689e
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,4 +93,7 @@ INFO - headline_post_a - Registering headline post action edit_incident_button
INFO - headline_post_a - Registering headline post action close_incident_button with order 300
INFO - headline_post_a - Registering headline post action my_cool_headline_action with order 150
```


## Release Process

See [release.md](release.md) for how to release an update.
10 changes: 10 additions & 0 deletions docs/release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Release Process

_Note: this can only be done by collaborators with write access_

1. Bump the version in [setup.py](../setup.py), commit to `master` and push
1. Go to https://github.com/monzo/response/releases, click "Draft a new release"
1. Enter the new tag version. This should be in the format `release-<major>.<minor>.<patch>`, e.g. `release-0.1.5`
1. Enter a bit of detail about what’s gone in since the last release, maybe include a list of the PRs
1. Travis CI should automatically pick up the tag and start a new build/test/deploy run. Keep an eye on https://travis-ci.org/monzo/response for this
1. This will push to PyPI, and generally takes around 5-10 minutes. If you want to check it’s uploaded successfully, go to https://pypi.org/project/django-incident-response/, which will always display the latest semver pushed to PyPI

0 comments on commit b6d689e

Please sign in to comment.