-
Notifications
You must be signed in to change notification settings - Fork 4.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix build: prevent verify-misspelling failing on releases #5643
Conversation
Removes pull request subjects from release notes and checks the remainder of text.
da506fc
to
3127296
Compare
/ok-to-test |
Thanks @Mikulas hmm, I'm not sure which is better, to fix the mispellings or do this... |
On second review, this is great @Mikulas thanks for the quick fix! /lgtm |
@mikesplain Yeah I get that, feel free to close this if it adds too much complexity to the tests. I honestly started this pull request by changing the release note file first, but it just made little sense to change the pull request labels. Next solution that came to mind was just skipping the 10.0 release notes altogether, but that would not fix future release notes. |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: mikesplain, Mikulas The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
@Mikulas This seems right to me, misspelling checking was only added a few months ago so this is our first pass on it. I agree that this, or something like it makes sense. For now, we can get this in and adjust as we go if need be. Thanks again! |
Removes pull request subjects from release notes and checks the remainder of text.
I'd say the pull requests should be listed with the original subjects, even if they include a typo. Very likely the typos are even intentional, such as in
It lists files in
docs/releases
and for each release, it removes lines matching a pull request. Intentionally the files are not changed inplace, as I feel running tests should not change any files. Instead, it writes to.build/docs
, because a/ it's already git ignored b/ gets cleaned withmake clean
The bash is slightly more convoluted than it seemingly has to be, but it's an intentional workaround macOS sed and it's wrong behavior with
-i''
.This changes the output of the misspell command, which may be confusing:
Note that it says
./.build/docs/1.10-NOTES.md
instead of./docs/releases/1.10-NOTES.md