Consolidate lingering news fragments named 'docs' #3078
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The previous existing implementation would just check for the existence of a preconfigured substring (e.g. `changes`, `doc`, ...). However that can be problematic when the used extension contains one of the valid substrings but is not valid itself. For example `changelog.d/3034.docs.rst` contains the valid `doc` substring but is not a valid name itself. The correct would be `changelog.d/3034.doc.rst`.
|
Brilliant. Thanks! |
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary of changes
This change address partially #3076.
The following tasks are handled:
Instead of writing a check that fails if any files are left in the
chagelog.ddirectory aftertox -e finalize, I reworked the existingcheck_changesfunction.Previously, this function would check if the file name has one of the allowed substrings. While this check is useful it is not fail-proof. For example, a file named
9999.docs.rsthas the validdocsubstring so it would pass the check, but it would still be an invalid name.Pull Request Checklist
changelog.d/.(See documentation for details)