[doc] Add a check for changelogs and fix the issues encountered #6735

Pierre-Sassoulas · 2022-05-29T07:18:26Z

Type of Changes

	Type
✓	🔨 Refactoring
✓	📜 Docs

Description

Refs #6688

Pierre-Sassoulas · 2022-05-29T07:24:27Z

doc/whatsnew/0/0.x.rst

@@ -658,7 +658,7 @@ Release date: 2006-08-10
 * started a reference user manual


Not touching this file (unless it's a global sed) because it's a mix between Logilab's internal and bitbucket. Hard to tell, probably dead link anyway, and not very useful generally.

coveralls · 2022-05-29T07:24:52Z

Pull Request Test Coverage Report for Build 2419895913

0 of 0 changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage remained the same at 95.516%

Totals
Change from base Build 2417473648:	0.0%
Covered Lines:	16231
Relevant Lines:	16993

💛 - Coveralls

DanielNoord · 2022-05-29T07:37:53Z

script/check_changelog.py

+from pathlib import Path
+from re import Pattern
+
+ISSUE_NUMBER_PATTERN = re.compile(r"#\d{1,5}")


Can't we reuse this pattern in the other patterns?

Suggested change

ISSUE_NUMBER_PATTERN = re.compile(r"#\d{1,5}")

ISSUE_NUMBER_PATTERN = re.compile(r"#\d+")

I see you're an optimist 😄

But I think it's a good test to keep 5, if we have a ticket going above 99999 in pylint it(s probably wrong. (Logilab's issue are above 100k for example.)

Still, let's reuse the pattern so if we ever need to change it that's just in one place.

Done in 9a60d73 with some bonus modularity

script/check_changelog.py

doc/user_guide/checkers/features.rst

github-actions · 2022-05-31T12:28:13Z

🤖 Effect of this PR on checked open source code: 🤖

Effect on pandas:
The following fatal messages are now emitted: 💣💥

astroid-error:
tests/.pylint_primer_tests/pandas-dev/pandas/pandas/tests/io/test_common.py: Fatal error while checking 'tests/.pylint_primer_tests/pandas-dev/pandas/pandas/tests/io/test_common.py'. Please open an issue in our bug tracker so we address this. There is a pre-filled template that you can use in '/home/runner/.cache/pylint/pylint-crash-2022-05-31-12.txt'.
Please check your changes on the following file:
https://github.com/pandas-dev/pandas.git/blob/main/pandas/tests/io/test_common.py#L1
astroid-error:
tests/.pylint_primer_tests/pandas-dev/pandas/pandas/tests/io/sas/test_sas7bdat.py: Fatal error while checking 'tests/.pylint_primer_tests/pandas-dev/pandas/pandas/tests/io/sas/test_sas7bdat.py'. Please open an issue in our bug tracker so we address this. There is a pre-filled template that you can use in '/home/runner/.cache/pylint/pylint-crash-2022-05-31-12.txt'.
Please check your changes on the following file:
https://github.com/pandas-dev/pandas.git/blob/main/pandas/tests/io/sas/test_sas7bdat.py#L1
astroid-error:
tests/.pylint_primer_tests/pandas-dev/pandas/pandas/tests/io/excel/test_readers.py: Fatal error while checking 'tests/.pylint_primer_tests/pandas-dev/pandas/pandas/tests/io/excel/test_readers.py'. Please open an issue in our bug tracker so we address this. There is a pre-filled template that you can use in '/home/runner/.cache/pylint/pylint-crash-2022-05-31-12.txt'.
Please check your changes on the following file:
https://github.com/pandas-dev/pandas.git/blob/main/pandas/tests/io/excel/test_readers.py#L1
astroid-error:
tests/.pylint_primer_tests/pandas-dev/pandas/pandas/tests/io/pytables/test_read.py: Fatal error while checking 'tests/.pylint_primer_tests/pandas-dev/pandas/pandas/tests/io/pytables/test_read.py'. Please open an issue in our bug tracker so we address this. There is a pre-filled template that you can use in '/home/runner/.cache/pylint/pylint-crash-2022-05-31-12.txt'.
Please check your changes on the following file:
https://github.com/pandas-dev/pandas.git/blob/main/pandas/tests/io/pytables/test_read.py#L1

The following messages are no longer emitted:

astroid-error:
tests/.pylint_primer_tests/pandas-dev/pandas/pandas/tests/io/test_common.py: Fatal error while checking 'tests/.pylint_primer_tests/pandas-dev/pandas/pandas/tests/io/test_common.py'. Please open an issue in our bug tracker so we address this. There is a pre-filled template that you can use in '/home/runner/.cache/pylint/pylint-crash-2022-05-31-11.txt'.
https://github.com/pandas-dev/pandas.git/blob/main/pandas/tests/io/test_common.py#L1
astroid-error:
tests/.pylint_primer_tests/pandas-dev/pandas/pandas/tests/io/sas/test_sas7bdat.py: Fatal error while checking 'tests/.pylint_primer_tests/pandas-dev/pandas/pandas/tests/io/sas/test_sas7bdat.py'. Please open an issue in our bug tracker so we address this. There is a pre-filled template that you can use in '/home/runner/.cache/pylint/pylint-crash-2022-05-31-11.txt'.
https://github.com/pandas-dev/pandas.git/blob/main/pandas/tests/io/sas/test_sas7bdat.py#L1
astroid-error:
tests/.pylint_primer_tests/pandas-dev/pandas/pandas/tests/io/excel/test_readers.py: Fatal error while checking 'tests/.pylint_primer_tests/pandas-dev/pandas/pandas/tests/io/excel/test_readers.py'. Please open an issue in our bug tracker so we address this. There is a pre-filled template that you can use in '/home/runner/.cache/pylint/pylint-crash-2022-05-31-11.txt'.
https://github.com/pandas-dev/pandas.git/blob/main/pandas/tests/io/excel/test_readers.py#L1
astroid-error:
tests/.pylint_primer_tests/pandas-dev/pandas/pandas/tests/io/pytables/test_read.py: Fatal error while checking 'tests/.pylint_primer_tests/pandas-dev/pandas/pandas/tests/io/pytables/test_read.py'. Please open an issue in our bug tracker so we address this. There is a pre-filled template that you can use in '/home/runner/.cache/pylint/pylint-crash-2022-05-31-11.txt'.
https://github.com/pandas-dev/pandas.git/blob/main/pandas/tests/io/pytables/test_read.py#L1

.pre-commit-config.yaml

DanielNoord · 2022-06-01T06:40:26Z

script/check_changelog.py

+]
+
+NO_CHECK_REQUIRED_FILES = {
+    "index.rst",


Shouldn't these be excluded in pre-commit? Feels a bit weird to exclude them here.

There's a function to select the file we want to check (sorted_whatsnew) and we're launching on the whole repository. The function has verbose log to troubleshoot, I'd rather keep that than to have to use an elaborate exclude regex. Also later on we could want to check that it's in the "right" file according to pylint's version and we need to have information about the whole repo and the other files to do that.

Hm, doesn't it make more sense to let this accept a files argument? That's how most of the linting, formatting, etc. tools work

It does the job, we won't use it that much (when we modify the old changelog), it's not perfect but I don't see the point in refactoring it to perfection right now as it's blocking 2.14. Let's refactor it if we're going to keep the

* blabla Closes #5445345

format in #6688 (I.e. after 2.14). Right now I think * blabla (#123456789) with 123456789 being the PR number and not the issue number would be better, which means we would delete this.

Also see #6781, if we auto-generate the changelog we won't need it either

Pierre-Sassoulas added the Documentation 📗 label May 29, 2022

Pierre-Sassoulas commented May 29, 2022

View reviewed changes

Pierre-Sassoulas requested a review from DanielNoord May 29, 2022 07:30

DanielNoord reviewed May 29, 2022

View reviewed changes

Pierre-Sassoulas mentioned this pull request May 29, 2022

[doc] Add a CI check for the doc being properly generated #6736

Merged

Pierre-Sassoulas force-pushed the changelog-check branch from 3811b57 to 690713c Compare May 31, 2022 12:01

Pierre-Sassoulas mentioned this pull request May 31, 2022

Better documentation for contributor installation #6775

Merged

Pierre-Sassoulas force-pushed the changelog-check branch 4 times, most recently from bee1dd3 to dcb9aa0 Compare May 31, 2022 15:15

Pierre-Sassoulas commented May 31, 2022

View reviewed changes

.pre-commit-config.yaml Outdated Show resolved Hide resolved

[doc] Add a check for changelogs and fix the issues encountered

6f5120d

Pierre-Sassoulas force-pushed the changelog-check branch from 11f7001 to 91cbfb9 Compare May 31, 2022 20:31

fix spelling

02f3e44

Pierre-Sassoulas force-pushed the changelog-check branch from 4e353c0 to 02f3e44 Compare May 31, 2022 20:33

Pierre-Sassoulas added 3 commits May 31, 2022 22:51

Use relpath for easier comparison of output

b347b1a

Better filtering and verbose mode

3bdd424

fix 1.3.rst

9a077de

Pierre-Sassoulas requested a review from DanielNoord May 31, 2022 21:42

Update .pre-commit-config.yaml

03d90ab

DanielNoord requested changes Jun 1, 2022

View reviewed changes

This was referenced Jun 1, 2022

Reorganize the changelog and the way it's displayed in the doc #6688

Closed

To-do list for 2.14.0 #5513

Closed

More modular variables for regexes

9a60d73

DanielNoord approved these changes Jun 1, 2022

View reviewed changes

Pierre-Sassoulas merged commit 214201a into pylint-dev:main Jun 1, 2022

Pierre-Sassoulas deleted the changelog-check branch June 1, 2022 09:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[doc] Add a check for changelogs and fix the issues encountered #6735

[doc] Add a check for changelogs and fix the issues encountered #6735

Pierre-Sassoulas commented May 29, 2022

Pierre-Sassoulas May 29, 2022

coveralls commented May 29, 2022 •

edited

DanielNoord May 29, 2022

Pierre-Sassoulas May 29, 2022

Pierre-Sassoulas May 31, 2022

DanielNoord Jun 1, 2022

Pierre-Sassoulas Jun 1, 2022

github-actions bot commented May 31, 2022

DanielNoord Jun 1, 2022

Pierre-Sassoulas Jun 1, 2022

DanielNoord Jun 1, 2022

Pierre-Sassoulas Jun 1, 2022 •

edited

Pierre-Sassoulas Jun 1, 2022

		@@ -658,7 +658,7 @@ Release date: 2006-08-10
		* started a reference user manual

	ISSUE_NUMBER_PATTERN = re.compile(r"#\d{1,5}")
	ISSUE_NUMBER_PATTERN = re.compile(r"#\d+")

[doc] Add a check for changelogs and fix the issues encountered #6735

[doc] Add a check for changelogs and fix the issues encountered #6735

Conversation

Pierre-Sassoulas commented May 29, 2022

Type of Changes

Description

Choose a reason for hiding this comment

coveralls commented May 29, 2022 • edited

Pull Request Test Coverage Report for Build 2419895913

💛 - Coveralls

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented May 31, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Pierre-Sassoulas Jun 1, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coveralls commented May 29, 2022 •

edited

Pierre-Sassoulas Jun 1, 2022 •

edited