diff options
-rw-r--r-- | .pre-commit-config.yaml | 7 | ||||
-rw-r--r-- | script/check_newsfragments.py | 84 |
2 files changed, 91 insertions, 0 deletions
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index bc3caf3a7..ce8215044 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -85,6 +85,13 @@ repos: language: system types: [text] files: ^(doc/whatsnew/\d+\.\d+\.rst) + - id: check-newsfragments + name: Check newsfragments + entry: python3 -m script.check_newsfragments + language: system + types: [text] + files: ^(doc/whatsnew/fragments) + exclude: doc/whatsnew/fragments/_.*.rst - repo: https://github.com/rstcheck/rstcheck rev: "v6.0.0.post1" hooks: diff --git a/script/check_newsfragments.py b/script/check_newsfragments.py new file mode 100644 index 000000000..cb5544f0b --- /dev/null +++ b/script/check_newsfragments.py @@ -0,0 +1,84 @@ +# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html +# For details: https://github.com/PyCQA/pylint/blob/main/LICENSE +# Copyright (c) https://github.com/PyCQA/pylint/blob/main/CONTRIBUTORS.txt + +"""Small script to check the formatting of news fragments for towncrier. +Used by pre-commit. +""" + +from __future__ import annotations + +import argparse +import re +import sys +from pathlib import Path +from re import Pattern + +VALID_ISSUES_KEYWORDS = [ + "Refs", + "Closes", + "Follow-up in", + "Fixes part of", +] +ISSUES_KEYWORDS = "|".join(VALID_ISSUES_KEYWORDS) +VALID_CHANGELOG_PATTERN = rf"(?P<description>(.*\n)*(.*\.\n))\n(?P<ref>({ISSUES_KEYWORDS}) (PyCQA/astroid)?#(?P<issue>\d+))" +VALID_CHANGELOG_COMPILED_PATTERN: Pattern[str] = re.compile( + VALID_CHANGELOG_PATTERN, flags=re.MULTILINE +) + + +def main(argv: list[str] | None = None) -> int: + parser = argparse.ArgumentParser() + parser.add_argument( + "filenames", + nargs="*", + metavar="FILES", + help="File names to check", + ) + parser.add_argument("--verbose", "-v", action="count", default=0) + args = parser.parse_args(argv) + is_valid = True + for filename in args.filenames: + is_valid &= check_file(Path(filename), args.verbose) + return 0 if is_valid else 1 + + +def check_file(file: Path, verbose: bool) -> bool: + """Check that a file contains a valid changelog entry.""" + with open(file, encoding="utf8") as f: + content = f.read() + match = VALID_CHANGELOG_COMPILED_PATTERN.match(content) + if match: + issue = match.group("issue") + if file.stem != issue: + print( + f"{file} must be named '{issue}.<fragmenttype>', after the issue it references." + ) + return False + if verbose: + print(f"Checked '{file}': LGTM 🤖👍") + return True + print( + f"""\ +{file}: does not respect the standard format 🤖👎 + +The standard format is: + +<one or more line of text> +<one blank line> +<issue reference> #<issuenumber> + +Where <issue reference> can be one of: {', '.join(VALID_ISSUES_KEYWORDS)} + +For example: + +``pylint.x.y`` is now a private API. + +Refs #1234 +""" + ) + return False + + +if __name__ == "__main__": + sys.exit(main()) |