Repository navigation
Document pre-release, backport, and security release processes - #2186
SashankBhamidi wants to merge 4 commits into
Conversation
|
Thanks for the pull request, @SashankBhamidi! A maintainer will review it shortly. |
| make new-version | ||
| #. Copy and paste the new version into an environment variable to use in subsequent commands during the release process. | ||
| #. Set an environment variable to use in subsequent commands during the release process. |
There was a problem hiding this comment.
I think the documentation should retain make new-version. It's a good helper command, but it can't grab versions from an earlier branch. IOW, after 8.x is released, it's not helpful for 7.x releases. I think we could pass an argument to look on the specific branch, perhaps:
make new-version BRANCH=7.xThere was a problem hiding this comment.
Added a note that make new-version reads from main; set VERSION manually for backports. BRANCH support would need a Makefile change. Worth a follow-up issue?
| git add CHANGES.rst news/ docs/conf.py | ||
| git add .github/workflows/tests.yml # Only for a new major release | ||
| git commit -m"version $VERSION" | ||
| git commit -m "version $VERSION" |
There was a problem hiding this comment.
haha, this is one of my pet peeves, either is valid, but the lack of a space triggers me.
| #. If the release is approved by a maintainer, it will be pushed to `PyPI`_. | ||
| Don't wait for that, continue. | ||
| Approve the deployment in GitHub Actions. | ||
| PyPI publishing uses `Trusted Publishing (OIDC) <https://docs.pypi.org/trusted-publishers/>`_; no API token is needed. |
There was a problem hiding this comment.
| PyPI publishing uses `Trusted Publishing (OIDC) <https://docs.pypi.org/trusted-publishers/>`_; no API token is needed. | |
| PyPI publishing uses `Trusted Publishing (OIDC) <https://docs.pypi.org/trusted-publishers/>`_. | |
| No API token is needed. |
| Don't wait for that, continue. | ||
| Approve the deployment in GitHub Actions. | ||
| PyPI publishing uses `Trusted Publishing (OIDC) <https://docs.pypi.org/trusted-publishers/>`_; no API token is needed. | ||
| The approval window is 30 days; if it expires, push a new tag with a bumped version number. |
There was a problem hiding this comment.
| The approval window is 30 days; if it expires, push a new tag with a bumped version number. | |
| The approval window is 30 days. | |
| If it expires, push a new tag with a bumped version number. |
| .. note:: | ||
| If the stable branch is behind the latest tag, push it forward before starting any backport. | ||
| A branch that's out of date causes cherry-pick conflicts and forces a version bump. |
There was a problem hiding this comment.
The "oopsie" should be before someone can do the "oopsie". If I were to run the above commands, then read this note, I'd poop a brick.
| .. warning:: | ||
| Tags cannot be moved or deleted once pushed. | ||
| If a release turns out to be broken, cut a new version; don't attempt to retag. |
There was a problem hiding this comment.
| If a release turns out to be broken, cut a new version; don't attempt to retag. | |
| If a release turns out to be broken, cut a new version. | |
| Don't attempt to retag. |
| #. Approve the ``deploy-tag-to-pypi`` and ``deploy-github-release`` jobs in `GitHub Actions <https://github.com/PyCalendar/icalendar/actions>`_ when they appear. | ||
| Only maintainers listed as Required Reviewers in :menuselection:`Settings --> Environments --> PyPI` can approve. | ||
| The approval window is 30 days; after that you'd need to retag with a new version. |
There was a problem hiding this comment.
| The approval window is 30 days; after that you'd need to retag with a new version. | |
| The approval window is 30 days. | |
| After that, you'd need to retag the commit with a new version. |
| Security releases | ||
| ----------------- | ||
| A security release follows the :ref:`backport-releases` process, with embargo until the fix ships. |
There was a problem hiding this comment.
| A security release follows the :ref:`backport-releases` process, with embargo until the fix ships. | |
| A security release follows the :ref:`backport-releases` process, with an embargo until the fix ships. |
| GHSAs? | ||
| retag(ged|ging|s)? |
There was a problem hiding this comment.
Sort these in the list, case-insensitively.
| @@ -0,0 +1 @@ | |||
| Added pre-release, backport release, and security release process documentation to :doc:`/contribute/maintenance`. @SashankBhamidi | |||
There was a problem hiding this comment.
New syntax will link to your GitHub Sponsors page, and if it doesn't exist, then redirects to your profile page.
| Added pre-release, backport release, and security release process documentation to :doc:`/contribute/maintenance`. @SashankBhamidi | |
| Added pre-release, backport release, and security release process documentation to :doc:`/contribute/maintenance`. :user:`SashankBhamidi` |
|
@SashankBhamidi thanks for the revisions. It's good stuff. |
|
Thanks for contributing to icalendar! Click here to see the progress of this Pull Request: Peer reviewWe value cooperation and peer learning. You have already opened a PR, so you know something others do not know. Please read how to give a good review.
|
Co-Authored-By: Steve Piercy <web@stevepiercy.com>
The release docs covered standard major/minor releases but had nothing on pre-releases, backports, or security fixes. I added sections for all three, and a post-release step to keep the stable branch current after each release.