Skip to content

Commit 28dfc55

Browse files
committed
Add section for publishing a new release
1 parent 9e598bd commit 28dfc55

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -484,6 +484,19 @@ excellent support for debugging console applications.
484484

485485
[PyCharm](https://www.jetbrains.com/pycharm/) is also quite good and has very nice [Code Inspection](https://www.jetbrains.com/help/pycharm/code-inspection.html) capabilities.
486486

487-
### Acknowledgement
487+
## Publishing a new release
488+
489+
Since 0.9.2, the process of publishing a new release of `cmd2` to [PyPi](https://pypi.org/) has been
490+
mostly automated. The manual steps are all git operations. Here's the checklist:
491+
492+
1. Make sure you are on the proper branch
493+
2. Make sure the version strings in `cmd2.py`, `conf.py`, `setup.py`, and `test_cmd2.py` are correct.
494+
3. Make sure all the unit tests pass.
495+
4. Make sure `CHANGELOG.md` describes the version and has the correct release date.
496+
5. Create and push a git tag that matches the version strings above.
497+
6. (Optional) Run `invoke pypi_test` to clean, build, and upload a new release to [Test PyPi](https://test.pypi.org)
498+
7. Run `invoke pypi` to clean, build, and upload a new release to [PyPi](https://pypi.org/)
499+
500+
## Acknowledgement
488501
Thanks to the good folks at [freeCodeCamp](https://github.com/freeCodeCamp/freeCodeCamp) for creating
489502
an excellent `CONTRIBUTING` file which we have borrowed heavily from.

0 commit comments

Comments
 (0)