From a8f921ce4dfeb190d45d0372379b366b43030695 Mon Sep 17 00:00:00 2001 From: Rust Saiargaliev Date: Sun, 30 Oct 2022 11:42:20 +0200 Subject: [PATCH] Document the release process (#2503) --- MAINTENANCE.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 MAINTENANCE.md diff --git a/MAINTENANCE.md b/MAINTENANCE.md new file mode 100644 index 00000000..cba674a8 --- /dev/null +++ b/MAINTENANCE.md @@ -0,0 +1,15 @@ +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. + * 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) +* 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