diff options
author | Seth Morton <seth.m.morton@gmail.com> | 2019-11-19 13:52:35 -0800 |
---|---|---|
committer | Seth Morton <seth.m.morton@gmail.com> | 2019-11-19 13:59:44 -0800 |
commit | ae12e044daabc163d20e1ca36f1aaaa7d7bd3967 (patch) | |
tree | 2a0478f50ea3738a22df5bf5969596d9c57f5cd4 /RELEASING.md | |
parent | 4b8bc2c9a3df539fa4493ceb27266fe1c8d36d1a (diff) | |
download | natsort-ae12e044daabc163d20e1ca36f1aaaa7d7bd3967.tar.gz |
Update RELEASING.md
The content now more closely aligns with the actual natsort release
process.
Add RELEASING.md to the manifest.
Diffstat (limited to 'RELEASING.md')
-rw-r--r-- | RELEASING.md | 35 |
1 files changed, 21 insertions, 14 deletions
diff --git a/RELEASING.md b/RELEASING.md index dfb1cf4..b2c069f 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -1,27 +1,34 @@ # Release Checklist - [ ] Get master to the appropriate code release state. - [Travis CI](https://travis-ci.org/SethMMorton/natsort) cleanly for all merges to - master. + [Travis CI](https://travis-ci.org/SethMMorton/natsort) must be passing: [![Build Status](https://travis-ci.org/SethMMorton/natsort.svg?branch=master)](https://travis-ci.org/SethMMorton/natsort) -- [ ] Tag with the version number: +- [ ] Ensure that the `CHANGELOG.md` includes the changes made since last release. + Please follow the style outlined in https://keepachangelog.com/. + All new entries should be added into the "Unreleased" section. -```bash -git tag -a 6.3.0 -``` +- [ ] Bump the version number. Specify either "major", "minor", or "patch": -- [ ] Push tag: + ```bash + tox -e bump patch + ``` -```bash -git push --tags -``` + This will take care of updating the `CHANGELOG.md` with the correct + release information. + +- [ ] Push the bumped commit and the tag: + + ```bash + git push + git push --tags + ``` - [ ] Check the tagged [Travis CI build](https://travis-ci.org/SethMMorton/natsort) has - deployed to [PyPI](https://pypi.org/project/natsort/#history) + deployed to [PyPI](https://pypi.org/project/natsort/#history). - [ ] Check installation: -```bash -pip3 uninstall -y natsort && pip3 install -U natsort -``` + ```bash + python -m pip uninstall -y natsort && python -m pip install -U natsort + ``` |