Skip to content

Commit

Permalink
Updated the version and CHANGELOG for 5.2.0 release; rpyc-release-pro…
Browse files Browse the repository at this point in the history
…cess.rst documents new process
  • Loading branch information
comrumino committed Jul 31, 2022
1 parent 67c5359 commit 9ea46d0
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 13 deletions.
30 changes: 30 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,33 @@
5.2.0
=====
Date: 2022-07-30

- `#494`_ Added support for using decorators to expose methods (see `#292`_)
- `#499`_ Allow `BgServingThread` serve and sleep intervals to be customized
- `#498`_ Avoid redefining `hasattr_static` on every `_check_attr` call
- `#489`_ Updated SSL context usage to avoid deprecated aspects and changes
- `#485`_ Add a configurable timeout on the zero deploy close method
- `#484`_ Fixed `--mode` CLI argument for `rpyc_registry`
- `#479`_ Fixed propagation of `AttributeErrors` raised by exposed descriptors
- `#476`_ Allow filtering by host on list_services
- `#493`_ and `#502`_ Improved documentation and fixed typos
- `#492`_ Some work around race conditions but proper fix is rather involved (see `#491`_)

.. _#502: https://github.com/tomerfiliba-org/rpyc/pull/502
.. _#499: https://github.com/tomerfiliba-org/rpyc/pull/499
.. _#498: https://github.com/tomerfiliba-org/rpyc/pull/498
.. _#494: https://github.com/tomerfiliba-org/rpyc/pull/494
.. _#489: https://github.com/tomerfiliba-org/rpyc/pull/489
.. _#485: https://github.com/tomerfiliba-org/rpyc/pull/485
.. _#484: https://github.com/tomerfiliba-org/rpyc/pull/484
.. _#479: https://github.com/tomerfiliba-org/rpyc/pull/479
.. _#476: https://github.com/tomerfiliba-org/rpyc/pull/476
.. _#492: https://github.com/tomerfiliba-org/rpyc/pull/492
.. _#493: https://github.com/tomerfiliba-org/rpyc/issues/493
.. _#491: https://github.com/tomerfiliba-org/rpyc/issues/491
.. _#307: https://github.com/tomerfiliba-org/rpyc/issues/307
.. _#292: https://github.com/tomerfiliba-org/rpyc/issues/292

5.1.0
=====
Date: 2022-02-26
Expand Down
23 changes: 12 additions & 11 deletions docs/docs/rpyc-release-process.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,18 @@ 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. Review `git diff`, commit changes, `git push`, and `export ver=$(python -c 'import rpyc; print(rpyc.__version__)')`.
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`
7. Clean up any old build artifacts: `git clean -Xf -- dist/`
8. Create a wheel package: `pyenv exec hatch -v build`
9. Upload the wheel package: `pyenv exec hatch -v publish`
10. Create new release such that the notes are from `CHANGELOG.rst` entry.
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 ``git add .``, ``git push``, and ``export ver=$(python -c 'import rpyc; print(rpyc.__version__)')``.
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!

.. _Semantic Versioning: https://semver.org/
.. _Versioning using Hatch: https://hatch.pypa.io/latest/version/
Expand Down
4 changes: 2 additions & 2 deletions rpyc/version.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
__version__ = '5.1.0'
__version__ = '5.2.0'
version = tuple(__version__.split('.'))
release_date = "2022-02-26"
release_date = "2022-07-30"

0 comments on commit 9ea46d0

Please sign in to comment.