Fix towncrier CI always failing #347
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
ItsDrike
added
t: bug
ItsDrike
changed the title
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.
After an automatic update of the towncrier dependency in #345, the CI started to fail in 2 places:
The sphinx documentation build
The
sphinxcontrib-towncrierextension isn't compatible with this latest version and fails due to a change in the towncrier internal API code, which this extension uses. See: Incompatible with Towncrier 24.7 sphinx-contrib/sphinxcontrib-towncrier#92. At the moment, the only way to fix this is to revert towncrier to an older version.The PR changelog fragment check
It seems that the new towncrier version no longer automatically ignores the template file. Since we place this file in the fragments directory,
towncrier checkalways fails with an error that this file isn't correctly named. The automatic update succeeded because these updates are exempt from changelog fragment presence check, so it got into main unnoticed.This PR fixes that by adding the template file to ignored files. (Even though the towncrier dependency will be reverted, the ignore can remain, as it at least prevents it from breaking once we do update)