From d64d1aa1e0fa410e58cc218e721eb4c3672ce5bd Mon Sep 17 00:00:00 2001 From: Ivan Pozdeev Date: Mon, 28 Oct 2024 02:53:18 +0300 Subject: [PATCH] MAINTENANCE.md: easier way to make a release --- MAINTENANCE.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/MAINTENANCE.md b/MAINTENANCE.md index cba674a8..42debf22 100644 --- a/MAINTENANCE.md +++ b/MAINTENANCE.md @@ -4,12 +4,14 @@ Creating a release The release of the new version of Pyenv is done via GitHub Releases. Release checklist: -* Start [drafting a new release on GitHub](https://github.com/pyenv/pyenv/releases) to generate a summary of changes. Save the summary locally. +* Start [drafting a new release on GitHub](https://github.com/pyenv/pyenv/releases) to generate a summary of changes. +Type the would-be tag name in the "Choose a tag" field and press "Generate release notes" * The summary may need editing. E.g. rephrase entries, delete/merge entries that are too minor or irrelevant to the users (e.g. typo fixes, CI) +* Update `CHANGELOG.md` with the new version number and the edited summary (only the changes section) * Push the version number in `libexec/pyenv---version` * Minor version is pushed if there are significant functional changes (not e.g. bugfixes/formula adaptations/supporting niche use cases). * Major version is pushed if there are breaking changes -* Update `CHANGELOG.md` with the new version number and the edited summary (only the changes section), reformatting it like the rest of the changelog sections * Commit the changes locally into `master` -* Create a new tag with the new version number and push the changes including the tag -* Create a new release on GitHub based on the tag, using the saved summary \ No newline at end of file +* Create a new tag locally with the same name as specified in the new release window +* Push the changes including the tag +* In the still open new release window, press "Publish release". The now-existing tag will be used. \ No newline at end of file