Skip to content

Commit 33f54ec

Browse files
committed
Add maintenance guide
1 parent f8469a1 commit 33f54ec

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

MAINTENANCE.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Creating a release
2+
==================
3+
4+
The release of the new version of Pyenv is done via GitHub Releases.
5+
6+
Release checklist:
7+
* Start [drafting a new release on GitHub](https://github.com/pyenv/pyenv-virtualenv/releases) to generate a summary of changes. Save the summary locally.
8+
* 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)
9+
* Push the version number in `bin/pyenv-virtualenv`
10+
* Minor version is pushed if there are significant functional changes (not e.g. bugfixes/formula adaptations/supporting niche use cases).
11+
* Major version is pushed if there are breaking changes
12+
* 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
13+
* Commit the changes locally into `master`
14+
* Create a new tag with the new version number and push the changes including the tag
15+
* Create a new release on GitHub based on the tag, using the saved summary

0 commit comments

Comments
 (0)