Skip to content

Commit

Permalink
Wip - New release process
Browse files Browse the repository at this point in the history
  • Loading branch information
Pierre-Sassoulas committed Apr 10, 2021
1 parent 4f0dc55 commit 3ce4187
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 26 deletions.
12 changes: 2 additions & 10 deletions ChangeLog
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ Pylint's ChangeLog

What's New in Pylint 2.8.0?
===========================
Release date: Undefined
Release date: 2021-04-11

..
Put new features here and also in 'doc/whatsnew/2.8.rst'
Put new features and bugfixes here and also in 'doc/whatsnew/2.8.rst'

* Use a prescriptive message for ``unidiomatic-typecheck``

Expand All @@ -30,14 +30,6 @@ Release date: Undefined

Closes #2822, #4206, #4284


What's New in Pylint 2.7.5?
===========================
Release date: Undefined

..
Put bug fixes that will be cherry-picked to latest major version here

* Reactivates old counts in report mode.

Closes #3819
Expand Down
24 changes: 8 additions & 16 deletions doc/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,18 +46,11 @@ twine upload dist/*

## Post release

### New branch to create for major releases
### Merge tags in master for pre-commit

The master branch will have all the new features for the `X.Y+1` version

If you're doing a major release, you need to create the `X.Y` branch where we will
cherry-pick bugs to release the `X.Y.Z+1` minor versions

### Merge tags in master for minor releases

Merge the tag `X.Y.Z` in the main branch by doing a history only merge. It's done in
order to signal that this is an official release tag, and for `pre-commit autoupdate` to
works.
If the tag you just made is not part of the main branch, merge the tag `X.Y.Z` in the
main branch by doing a history only merge. It's done in order to signal that this is an
official release tag, and for `pre-commit autoupdate` to works.

```bash
git checkout master
Expand All @@ -74,8 +67,8 @@ issue labelled as blocker.

#### Changelog

- Create a new section, with the name of the release `X.Y.Z+1` on the `X.Y` branch.
- If it's a major release, also create a new section for `X.Y+1.0` on the master branch
- Create a new section, with the name of the release `X.Y.Z+1` or `X.Y+1.0` on the
master branch.

You need to add the estimated date when it is going to be published. If no date can be
known at that time, we should use `Undefined`.
Expand All @@ -87,6 +80,5 @@ at the examples from `doc/whatsnew`.

### Versions

Update `__version__` to `X.Y+1.0` in `pylint/__pkginfo__.py` for `master` and to
`X.Y.Z+1` for the `X.Y` branch. `dev_version` should also be back to an integer after
the tag.
Update `__version__` to `X.Y+1.0` or `X.Y.Z+1` in `__pkginfo__`. `dev_version` should
also be back to an integer after the tag.

0 comments on commit 3ce4187

Please sign in to comment.