summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPierre Sassoulas <pierre.sassoulas@gmail.com>2021-04-07 22:22:07 +0200
committerPierre Sassoulas <pierre.sassoulas@gmail.com>2021-04-08 11:04:22 +0200
commitdb9b7cbfd131404be19002c5e6d1e143d73832d1 (patch)
tree3cefd12df00005355deed55fd93e8216dd559eb6
parent083c5d263080ea2063e1ddda044ead6deed44c88 (diff)
downloadpylint-git-db9b7cbfd131404be19002c5e6d1e143d73832d1.tar.gz
Upgrade the documentation and fix inconsistencies
-rw-r--r--ChangeLog2
-rw-r--r--doc/release.md26
-rw-r--r--doc/whatsnew/2.8.rst6
3 files changed, 20 insertions, 14 deletions
diff --git a/ChangeLog b/ChangeLog
index 5ed2fa9ae..6c7241230 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -16,7 +16,7 @@ Release date: Undefined
* Apply ``const-naming-style`` to module constants annotated with
``typing.Final``
-* The packaging is now done via setuptools exclusively. ``doc``, ``test``, ``man``, ``elisp`` and ``Changelog`` are
+* 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
diff --git a/doc/release.md b/doc/release.md
index 994a4f2b0..47a3fbe22 100644
--- a/doc/release.md
+++ b/doc/release.md
@@ -4,14 +4,14 @@ So, you want to release the `X.Y.Z` version of pylint ?
## Process
-1. Preparation 0. Run the acceptance tests to see if everything is alright with this
- release. We don't run them on CI: `pytest -m acceptance`
- 1. Check if the dependencies of the package are correct
- 2. Update `__version__` in `pylint/__pkginfo__.py`, `dev_version` should be `None`
- when you tag, except if it's an alpha release.
- 3. Put the version numbers, and the release date into the changelog
- 4. Put the release date into the `What's new` section.
- 5. Generate the new copyright notices for this release:
+1. Run the acceptance tests to see if everything is alright with this release. We don't
+ run them on CI: `pytest -m acceptance`
+2. Check if the dependencies of the package are correct
+3. Update `__version__` in `pylint/__pkginfo__.py`, `dev_version` should be `None` when
+ you tag, except if it's an alpha release.
+4. Put the version numbers, and the release date into the changelog
+5. Put the release date into the `What's new` section.
+6. Generate the new copyright notices for this release:
```bash
pip3 install copyrite
@@ -21,17 +21,17 @@ git --aliases=.copyrite_aliases . --jobs=8
# automatically
```
-6. Submit your changes in a merge request.
+7. Submit your changes in a merge request.
-7. Make sure the tests are passing on Travis/GithubActions:
+8. Make sure the tests are passing on Travis/GithubActions:
https://travis-ci.org/PyCQA/pylint/
-8. Do the actual release by tagging the master with `pylint-X.Y.Z` (ie `pylint-1.6.12`
+9. Do the actual release by tagging the master with `pylint-X.Y.Z` (ie `pylint-1.6.12`
for example). Travis should deal with the release process once the tag is pushed with
`git push origin --tags`
-9. Go to github, click on "Releases" then on the `pylint-X.Y.Z` tag, choose edit tag,
- and copy past the changelog in the description.
+10. Go to github, click on "Releases" then on the `pylint-X.Y.Z` tag, choose edit tag,
+ and copy past the changelog in the description.
## Manual Release
diff --git a/doc/whatsnew/2.8.rst b/doc/whatsnew/2.8.rst
index a40977868..6f502fa94 100644
--- a/doc/whatsnew/2.8.rst
+++ b/doc/whatsnew/2.8.rst
@@ -20,3 +20,9 @@ Other Changes
* Reduce usage of blacklist/whitelist terminology. Notably, ``extension-pkg-allow-list`` is an
alternative to ``extension-pkg-whitelist`` and the message ``blacklisted-name`` is now emitted as
``disallowed-name``. The previous names are accepted to maintain backward compatibility.
+
+* 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%.
+
+* The 'doc' extra-require has been removed. ``pylint.version`` is now ``pylint.__version__`` and ``__pkginfo__`` does
+ not contain the package metadata anymore.