summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPierre Sassoulas <pierre.sassoulas@gmail.com>2022-02-27 22:56:43 +0100
committerPierre Sassoulas <pierre.sassoulas@gmail.com>2022-03-24 13:41:46 +0100
commitc508d84858228dbd37214a9747b8073afa16e643 (patch)
tree255ab732855ace1b8c14af137b1e01d279eeb97b
parent2b6184ba758ca7b2645ffccf678cdfa750d9f09c (diff)
downloadpylint-git-c508d84858228dbd37214a9747b8073afa16e643.tar.gz
Adaptation for pylint
-rw-r--r--doc/release.md9
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/release.md b/doc/release.md
index 9052927b4..25c87bbe5 100644
--- a/doc/release.md
+++ b/doc/release.md
@@ -1,6 +1,6 @@
-# Releasing an astroid version
+# Releasing a pylint version
-So, you want to release the `X.Y.Z` version of astroid ?
+So, you want to release the `X.Y.Z` version of pylint ?
## Releasing a major or minor version
@@ -16,6 +16,8 @@ the maintenance branch. If so, release a last patch release first. See
- Bump the version and release by using `tbump X.Y.0 --no-push --no-tag`. (For example:
`tbump 2.4.0 --no-push --no-tag`)
- Check the commit created with `git show` amend the commit if required.
+- Create a new `What's new in Pylint X.Y+1` document. Add it to `doc/index.rst`. Take a
+ look at the examples from `doc/whatsnew`. Commit that with `git commit -am "wip"`.
- Move the `main` branch up to a dev version with `tbump`:
```bash
@@ -30,7 +32,8 @@ tbump 2.5.0-dev0 --no-tag --no-push
git commit -am "Upgrade the version to 2.5.0-dev0 following 2.4.0 release"
```
-Check the commit and then push to a release branch
+Check the commit, fixup the 'wip' commit with the what's new then push to a release
+branch
- Open a merge request with the two commits (no one can push directly on `main`)
- Trigger the "release tests" workflow in GitHub Actions.