Skip to content

#719 Update release docs. #720

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adiroiban merged 4 commits into from
Nov 23, 2025
Merged

#719 Update release docs. #720

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5e7c9f8
Update docs.
adiroiban Aug 30, 2025
d26fe24
Add separate section for the merge.
adiroiban Aug 30, 2025
e02a209
Apply suggestion from @twm
adiroiban Nov 23, 2025
5a9598b
Merge branch 'trunk' into 719-release-docs-prerelease-failure
adiroiban Nov 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 18 additions & 6 deletions RELEASE.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,17 +69,23 @@ Release candidate publish failures

The PyPI publish process is automatically triggered when a tag is created.

The publish is skipped for PRs, so we can check that the automated process works only a release time.
The publish is skipped for PRs, so we can **only check** that the automated process works at release time.
It can happen for the automated publish process to fail.

As long as the package was not published to PyPI, do the followings:
As long as the package was not published to PyPI, we will only "yank" it from GitHub, as there is nothing to yank on PyPI.

* Manually delete the candidate release from GitHub releases
* Manually delete the tag for the release candidate
To yank from GitHub release, keep the release title, and tag,
but remove the description and replace it with this content.

Try to fix the issue and trigger the same release candidate again.
.. ::

Once the package is published on PyPI, do not delete the release or the tag.
> [!CAUTION]
> This tag corresponds to a release that never made it to PyPI.

Try to fix the issue and trigger the a new release candidate with a new tag.

Once the package is published on PyPI,
**do not delete** the release or the tag.
Proceed with create a new release candidate instead.


Expand Down Expand Up @@ -119,6 +125,12 @@ Similar to the release candidate, with the difference:

No need for another review request.


Merge the release branch
------------------------

Once the release is done, we can prepare for a new development cycle and merge the release branch.

Update the version to the development version.
In ``pyproject.toml`` the version is set using a PEP440 compliant string:

Expand Down
Empty file added src/towncrier/newsfragments/719.misc
View file
Open in desktop
Empty file.
Loading