RPyC Release Process

A walkthrough of doing a RPyC Release.

  1. Ensure a clean and current build environment (i.e., git pull; git status)

  2. Describe commit history within CHANGELOG.rst (see Generate Entry)

  3. Update release_date in rpyc/version.py and bump version (Semantic Versioning and Versioning using Hatch)

  4. Verify changes and run export ver=$(python -c 'import rpyc; print(rpyc.__version__)'), git add ., and git push.

  5. Create an Annotated tag: git tag -a ${ver} -m "Updated CHANGELOG.rst and version for release ${ver}"

  6. Publish release tag: git push origin ${ver}

  7. Install hatch: pyenv exec pip install hatch

  8. Clean up any old build artifacts: git clean -Xf -- dist/

  9. Create a wheel package: pyenv exec hatch -v build

  10. Upload the wheel package: pyenv exec hatch -v publish --user=__token__ --auth=${pypi_token} ; history -c && history -w

  11. Create new release such that the notes are from CHANGELOG.rst entry (%s/`#/#/g and %s/`_//g)

  12. Make sure to add the wheel as an attachment to the release and you are done!

Generate CHANGELOG.rst Entry

To create an initial entry draft, run some shell commands.

Once insert this entry at the top of CHANGELOG.rst, review what it looks like with instant-rst.

instantRst -b chromium -p 8612 -f "CHANGELOG.rst"

Misc. References