Skip to content

Commit ca447f7

Browse files
Upgrade documentation for the new release script
1 parent d5da91e commit ca447f7

File tree

1 file changed

+8
-19
lines changed

1 file changed

+8
-19
lines changed

doc/release.md

Lines changed: 8 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,13 @@ So, you want to release the `X.Y.Z` version of pylint ?
44

55
## Process
66

7-
1. Check if the dependencies of the package are correct, make sure astroid is pinned to
8-
the latest version.
9-
2. Put the release date into`What's new` if it's a minor version.
10-
3. Install the release dependencies `pip3 install pre-commit tbump`
11-
4. Bump the version and release by using `tbump X.Y.Z --no-push`.
12-
5. Check the result.
13-
6. Push the tag.
14-
7. Go to GitHub, click on "Releases" then on the `vX.Y.Z` tag, choose edit tag, and copy
7+
1. Check if the dependencies of the package are correct, make sure that astroid is
8+
pinned to the latest version.
9+
2. Install the release dependencies `pip3 install pre-commit tbump`
10+
3. Bump the version and release by using `tbump X.Y.Z --no-push`.
11+
4. Check the result.
12+
5. Push the tag.
13+
6. Go to GitHub, click on "Releases" then on the `vX.Y.Z` tag, choose edit tag, and copy
1514
past the changelog in the description. This will trigger the release to pypi.
1615

1716
## Post release
@@ -45,17 +44,7 @@ tbump X.Y.Z-dev0 --no-tag --no-push # You can interrupt during copyrite
4544

4645
Check the result and then upgrade the master branch
4746

48-
#### Changelog
49-
50-
If it was a minor release add a `X.Y+1.0` title following the template:
51-
52-
```text
53-
What's New in pylint x.y.z?
54-
============================
55-
Release Date: TBA
56-
```
57-
5847
#### Whatsnew
5948

60-
If it's a minor release, create a new `What's new in Pylint X.Y+1` document Take a look
49+
If it's a minor release, create a new `What's new in Pylint X.Y+1` document. Take a look
6150
at the examples from `doc/whatsnew`.

0 commit comments

Comments
 (0)