summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPierre Sassoulas <pierre.sassoulas@gmail.com>2021-04-07 22:24:13 +0200
committerPierre Sassoulas <pierre.sassoulas@gmail.com>2021-04-24 20:57:28 +0200
commit90132e5af74ad0ca56eaca0f35e08abef739eb3f (patch)
tree4d95b69c69d48a0713709047147ed85625282bc0
parent29ec50e9b0dce5f75328efcb7cf060900119be49 (diff)
downloadpylint-git-90132e5af74ad0ca56eaca0f35e08abef739eb3f.tar.gz
Document the new release process
-rw-r--r--ChangeLog22
-rw-r--r--doc/release.md24
2 files changed, 17 insertions, 29 deletions
diff --git a/ChangeLog b/ChangeLog
index becd9d4db..368aff40a 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -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'
* New refactoring message ``consider-using-with``. This message is emitted if resource-allocating functions or methods of the
standard library (like ``open()`` or ``threading.Lock.acquire()``) that can be used as a context manager are called without
@@ -34,9 +34,13 @@ Release date: Undefined
``typing.Final``
* The packaging is now done via setuptools exclusively. ``doc``, ``tests``, ``man``, ``elisp`` and ``Changelog`` are
- not packaged anymore - reducing the size of the package by 75%. Debian packaging is now (officially) done in
- https://salsa.debian.org/python-team/packages/pylint. The 'doc' extra-require has been removed. ``__pkginfo__`` now
- only contain ``__version__`` (also accessible with ``pylint.__version__``), other meta-information are still
+ not packaged anymore - reducing the size of the package by 75%.
+
+* Debian packaging is now (officially) done in https://salsa.debian.org/python-team/packages/pylint.
+
+* The 'doc' extra-require has been removed.
+
+* ``__pkginfo__`` now only contain ``__version__`` (also accessible with ``pylint.__version__``), other meta-information are still
accessible with ``import importlib;metadata.metadata('pylint')``.
* COPYING has been renamed to LICENSE for standardization.
@@ -62,14 +66,6 @@ Release date: Undefined
(For example, 'typing.Dict' can be replaced by 'dict', and 'typing.Unions' by '|', etc.)
Make sure to check the config options if you plan on using it!
-
-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
diff --git a/doc/release.md b/doc/release.md
index 47a3fbe22..fc0805ead 100644
--- a/doc/release.md
+++ b/doc/release.md
@@ -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
@@ -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`.
@@ -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.