summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPierre Sassoulas <pierre.sassoulas@gmail.com>2021-06-29 20:34:50 +0200
committerPierre Sassoulas <pierre.sassoulas@gmail.com>2021-06-29 21:13:47 +0200
commitca447f7d93a002eb7d4dd80ff4caaf28ce8702b6 (patch)
tree131a1cb73b3ba8cf93f5e912f1a42d3ef36c4830
parentd5da91e55043a00d0e81e9caf8bd0071f0652f4e (diff)
downloadpylint-git-ca447f7d93a002eb7d4dd80ff4caaf28ce8702b6.tar.gz
Upgrade documentation for the new release script
-rw-r--r--doc/release.md27
1 files changed, 8 insertions, 19 deletions
diff --git a/doc/release.md b/doc/release.md
index a57e5c55f..e8185c348 100644
--- a/doc/release.md
+++ b/doc/release.md
@@ -4,14 +4,13 @@ So, you want to release the `X.Y.Z` version of pylint ?
## Process
-1. Check if the dependencies of the package are correct, make sure astroid is pinned to
- the latest version.
-2. Put the release date into`What's new` if it's a minor version.
-3. Install the release dependencies `pip3 install pre-commit tbump`
-4. Bump the version and release by using `tbump X.Y.Z --no-push`.
-5. Check the result.
-6. Push the tag.
-7. Go to GitHub, click on "Releases" then on the `vX.Y.Z` tag, choose edit tag, and copy
+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
past the changelog in the description. This will trigger the release to pypi.
## Post release
@@ -45,17 +44,7 @@ tbump X.Y.Z-dev0 --no-tag --no-push # You can interrupt during copyrite
Check the result and then upgrade the master branch
-#### Changelog
-
-If it was a minor release add a `X.Y+1.0` title following the template:
-
-```text
-What's New in pylint x.y.z?
-============================
-Release Date: TBA
-```
-
#### Whatsnew
-If it's a minor release, create a new `What's new in Pylint X.Y+1` document Take a look
+If it's a minor release, create a new `What's new in Pylint X.Y+1` document. Take a look
at the examples from `doc/whatsnew`.