Skip to content

Commit

Permalink
Upgrade documentation for the new release script
Browse files Browse the repository at this point in the history
  • Loading branch information
Pierre-Sassoulas committed Jun 29, 2021
1 parent d5da91e commit ca447f7
Showing 1 changed file with 8 additions and 19 deletions.
27 changes: 8 additions & 19 deletions doc/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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`.

0 comments on commit ca447f7

Please sign in to comment.