Skip to content

Commit

Permalink
WIP - Change to the release process
Browse files Browse the repository at this point in the history
  • Loading branch information
Pierre-Sassoulas committed Apr 4, 2021
1 parent 7f0e48e commit 42198a5
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 27 deletions.
13 changes: 2 additions & 11 deletions ChangeLog
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,15 @@
Pylint's ChangeLog
------------------

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

..
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'

* Apply ``const-naming-style`` to module constants annotated with
``typing.Final``


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

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

* Improved protected access checks to allow access inside class methods

Closes #1159
Expand Down
23 changes: 7 additions & 16 deletions doc/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,18 +47,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 @@ -75,8 +68,7 @@ if it's an 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 @@ -88,6 +80,5 @@ Take a look at the examples from ``doc/whatsnew``.

### Versions

Update ``numversion`` to ``X.Y+1.0`` in ``__pkginfo__`` 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 ``numversion`` 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 42198a5

Please sign in to comment.