Skip to content

Commit

Permalink
Fixed ref and switched to code-black::bash for rpyc-release-process.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
comrumino committed Feb 26, 2022
1 parent 4cb273c commit 04213d6
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/docs/rpyc-release-process.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ RPyC Release Process

A walkthrough of doing a RPyC Release.

1. Describe commit history within `CHANGELOG.rst` (i.e. :ref:`Generate Entry<Generate CHANGELOG.rst Entry>`)
1. Describe commit history within `CHANGELOG.rst` (see `Generate Entry`_)
2. Update `version` and `release_date` values for `rpyc/version.py` (`Semantic Versioning`_)
3. Review `git status`, commit changes, and `git push`.
4. Create an Annotated tag: `git tag -a 5.X.Y -m "Updated CHANGELOG.rst and version for release 5.X.Y"`
Expand All @@ -15,10 +15,14 @@ A walkthrough of doing a RPyC Release.

.. _Semantic Versioning: https://semver.org/

.. _Generate Entry:

Generate CHANGELOG.rst Entry
---------------------------------
To create an initial entry draft, run some shell commands.

.. code-block:: bash
last_release="1/12/2021"
log_since="$(git log --since="${last_release}" --merges --oneline)"
pulls=( $(echo "${log_since}" | sed -n 's/^.*request #\([0-9]*\) from .*$/\1/p') )
Expand All @@ -35,6 +39,8 @@ 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`.

.. code-block:: bash
instantRst -b chromium -p 8612 -f "CHANGELOG.rst"

0 comments on commit 04213d6

Please sign in to comment.