diff options
author | Pierre Sassoulas <pierre.sassoulas@gmail.com> | 2021-07-01 14:58:59 +0200 |
---|---|---|
committer | Pierre Sassoulas <pierre.sassoulas@gmail.com> | 2021-07-11 20:53:08 +0200 |
commit | a6fb91760ff1f426eef98ec928426134a9e23ef8 (patch) | |
tree | d2fbb35dab454f4e5ca0c97566b6ae63b4471dfc /doc | |
parent | 73089b5a02d11d4a2bb9513d3764aec40b873a4a (diff) | |
download | pylint-git-a6fb91760ff1f426eef98ec928426134a9e23ef8.tar.gz |
[release doc] Document the way the release can be done
Diffstat (limited to 'doc')
-rw-r--r-- | doc/release.md | 32 |
1 files changed, 17 insertions, 15 deletions
diff --git a/doc/release.md b/doc/release.md index 151c638e8..dcbb11894 100644 --- a/doc/release.md +++ b/doc/release.md @@ -7,10 +7,21 @@ So, you want to release the `X.Y.Z` version of pylint ? 1. Check if the dependencies of the package are correct, make sure that astroid is pinned to the latest version. 2. Install the release dependencies `pip3 install pre-commit tbump` -3. Bump the version and release by using `tbump X.Y.Z --no-push`. -4. Check the result. -5. Push the tag. -6. Go to GitHub, click on "Releases" then on the `vX.Y.Z` tag, choose edit tag, and copy +3. Bump the version by using `tbump X.Y.Z --no-tag --no-push` +4. Check the result +5. Move back to a dev version for pylint with `tbump`: + +```bash +tbump X.Y.Z+1-dev0 --no-tag --no-push # You can interrupt during copyrite +git commit -am "Move back to a dev version following X.Y.Z release" +``` + +4. Check the result +5. Open a merge request with the two commits (no one can push directly on `main`) +6. After the merge recover the merged commits and tag the first one (the version should + be `X.Y.Z`) as `vX.Y.Z` +7. Push the tag +8. Go to GitHub, click on "Releases" then on the `vX.Y.Z` tag, choose edit tag, and copy past the changelog in the description. This will trigger the release to pypi. ## Post release @@ -32,17 +43,8 @@ git push We move issue that were not done in the next milestone and block release only if it's an issue labelled as blocker. -### Back to a dev version - -1. Unpin the version of astroid, so it's possible to install a dev version during - development -2. Move back to a dev version for pylint with `tbump`: - -```bash -tbump X.Y.Z-dev0 --no-tag --no-push # You can interrupt during copyrite -``` - -Check the result and then upgrade the main branch +- Close milestone `X.Y.Z` +- Create the milestones for `X.Y.Z+1`, (or `X.Y+1.0`, and `X+1.0.0` if applicable) #### Whatsnew |