You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The Changelog Entry Check which is run against PR's requires that CHANGES.md contains a reference the the PR.
However the Lint check runs prettier against CHANGES.md which can sometimes insist on breaking apart a PR reference.
To Reproduce
Add the following line to CHANGES.md:
- `Black` now requires one-line docstrings to not have leading or trailing spaces (PR #1234)
Submit a PR containing this change.
The Lint / build (3.7) (pull_request) check will fail since this line is too long. It states that this needs to be changed to:
- `Black` now requires one-line docstrings to not have leading or trailing spaces (PR
#1234)
However making this change results in the Changelog Entry Check (pull_request) failing since it's grep for "PR #1234" does not match the PR reference now that has been split over two lines.
Expected behavior
Changelog Entry Check should match for "PR #1234" even if it is split over multiple lines. So the formatting required by Black can be accepted.
Environment (please complete the following information):
Version: master
OS and Python version: Github action
Does this bug also happen on master?
Yes
The text was updated successfully, but these errors were encountered:
MarkCBell
changed the title
Black's Changelog Entry Check and Lint check run on PRs can contradict each other
Black's Changelog Entry and Lint checks that are run on PRs can contradict each other
Mar 27, 2021
Describe the bug
The Changelog Entry Check which is run against PR's requires that CHANGES.md contains a reference the the PR.
However the Lint check runs prettier against CHANGES.md which can sometimes insist on breaking apart a PR reference.
To Reproduce
However making this change results in the Changelog Entry Check (pull_request) failing since it's grep for "PR #1234" does not match the PR reference now that has been split over two lines.
Expected behavior
Changelog Entry Check should match for "PR #1234" even if it is split over multiple lines. So the formatting required by Black can be accepted.
Environment (please complete the following information):
Does this bug also happen on master?
Yes
The text was updated successfully, but these errors were encountered: