Skip to content

Document pre-release, backport, and security release processes - #2186

Open
SashankBhamidi wants to merge 4 commits into
mainfrom
release-process-docs
Open

SashankBhamidi wants to merge 4 commits into
mainfrom
release-process-docs

Conversation

@SashankBhamidi

Copy link
Copy Markdown
Member

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.

@github-actions

Copy link
Copy Markdown
Contributor

Thanks for the pull request, @SashankBhamidi! A maintainer will review it shortly.

Comment thread docs/contribute/maintenance.rst Outdated
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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.x

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

haha, this is one of my pet peeves, either is valid, but the lack of a space triggers me.

Comment thread docs/contribute/maintenance.rst Outdated
#. 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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

Comment thread docs/contribute/maintenance.rst Outdated
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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

Comment thread docs/contribute/maintenance.rst Outdated
Comment on lines +375 to +378
.. 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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread docs/contribute/maintenance.rst Outdated
.. 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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

Comment thread docs/contribute/maintenance.rst Outdated
#. 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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

Comment thread docs/contribute/maintenance.rst Outdated
Security releases
-----------------
A security release follows the :ref:`backport-releases` process, with embargo until the fix ships.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

Comment on lines +32 to +33
GHSAs?
retag(ged|ging|s)?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New syntax will link to your GitHub Sponsors page, and if it doesn't exist, then redirects to your profile page.

Suggested change
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`

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that's new

@stevepiercy

Copy link
Copy Markdown
Member

@SashankBhamidi thanks for the revisions. It's good stuff.

@dashboard-pycal-org

dashboard-pycal-org Bot commented Nov 20, 2026 •

Copy link
Copy Markdown

Thanks for contributing to icalendar!

Click here to see the progress of this Pull Request:

Peer review

We value cooperation and peer learning.

You have already opened a PR, so you know something others do not know.
This is the time to review to other Pull Requests and receive a review yourself.

Please read how to give a good review.

  • Peer reviews required
    This pull request needs more reviews from other people to progress.
  • Review other pull requests
    Your pull request will receive several reviews on the way to being merged.
    By giving others a review, you help share the load and move the project and your PR forward faster.

Co-Authored-By: Steve Piercy <web@stevepiercy.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants