2022-10-30 09:42:20 +00:00
|
|
|
Creating a release
|
|
|
|
|
==================
|
|
|
|
|
|
|
|
|
|
The release of the new version of Pyenv is done via GitHub Releases.
|
|
|
|
|
|
|
|
|
|
Release checklist:
|
2024-10-27 23:53:18 +00:00
|
|
|
* 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"
|
2022-10-30 09:42:20 +00:00
|
|
|
* 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)
|
2024-10-27 23:53:18 +00:00
|
|
|
* Update `CHANGELOG.md` with the new version number and the edited summary (only the changes section)
|
2022-10-30 09:42:20 +00:00
|
|
|
* 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
|
|
|
|
|
* Commit the changes locally into `master`
|
2024-10-27 23:53:18 +00:00
|
|
|
* 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.
|
