Skip to content

Commit f777c3e

Browse files
committed
Update release process
1 parent 8b4e24e commit f777c3e

File tree

1 file changed

+18
-9
lines changed

1 file changed

+18
-9
lines changed

tools/build_release.py

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -43,28 +43,37 @@ def main():
4343
* `pip install --upgrade twine tox` into whichever Python 2.7 you use to build
4444
4545
Steps
46-
* Make sure master is ready for release
46+
* Build master to ensure it is in a good state and ready for release
47+
* Ensure no commits are made on master until the release is complete
48+
* Create and checkout a branch for release-related changes
49+
* Update changelog
4750
* Update the changelog to show the version of the release
4851
* Change unreleased in TOC to new version
49-
* Commit to master
52+
* Commit to branch
5053
* `python3 tools/build_release.py --update --release`
5154
* This will update all the versions to remove any '.devN'
52-
* Commit to master
55+
* Commit to branch
5356
* `python3 tools/build_release.py --build`
5457
* Clean and build to update generated files with new version
55-
* Commit to master
58+
* Commit to branch
59+
* Create a pull request
60+
* It should contain all the changes made so far
61+
* Get the pull request reviewed but DO NOT merge to master yet
5662
* `python3 tools/build_release.py --upload`
5763
* Upload to PyPI - you will need to type in your credentials
58-
* Push all changes to GitHub
64+
* Merge the pull request to origin/master
5965
* Create a release on GitHub using the portion from the changelog for this release for the description
66+
* Create and checkout another branch for post-release changes
6067
* `python3 tools/build_release.py --update`
6168
* This will update the version to X.X.(N+1).dev0
62-
* Commit to master
69+
* Commit to branch
6370
* `python3 tools/build_release.py --build`
6471
* Clean and Build to update generated files
65-
* Commit to master
66-
* Copy Unreleased section from bottom of changelog to the top and add a link to it in the TOC
67-
* Push to GitHub
72+
* Commit to branch
73+
* Update changelog
74+
* Copy Unreleased section from bottom of changelog to the top and add a link to it in the TOC
75+
* Commit to branch
76+
* Create a pull request containing post-release changes and get it merged
6877
6978
"""
7079
parser = argparse.ArgumentParser(description=usage, formatter_class=CustomFormatter)

0 commit comments

Comments
 (0)