feat(tooling,ci): add changelog formatting validation #1691
Conversation
This file contains hidden or 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
richardgreg
force-pushed
the
feature/changelog-validation
branch
from
2be974d to
cd38818
Compare
richardgreg
changed the title
|
Will fix the case of it flagging colons |
richardgreg
force-pushed
the
feature/changelog-validation
branch
from
cd38818 to
3b3dc8e
Compare
richardgreg
changed the title
danceratopz
reviewed
Jun 4, 2025
There was a problem hiding this comment.
Thanks for adding this. You've added this to the tox_verify.yaml workflow, which runs checks managed by tox.ini. I think this is correct, but to avoid surprises in CI, it should be readily executable from tox.ini, so it can easily be ran locally. I made a suggestion below where this could be added.
richardgreg
force-pushed
the
feature/changelog-validation
branch
from
3b3dc8e to
e76dab9
Compare
danceratopz
reviewed
Jun 5, 2025
.github/workflows/tox_verify.yaml
Outdated
| @@ -82,6 +82,22 @@ jobs: | |||
| - name: Build html documentation with mkdocs via tox | |||
| run: uvx --with=tox-uv tox -e mkdocs | |||
|
|
|||
| changelog: | |||
| @@ -37,7 +37,10 @@ commands = python -c "import src.cli.tox_helpers; src.cli.tox_helpers.pyspelling | |||
| [testenv:markdownlint] | |||
| description = Lint markdown files (markdownlint) | |||
| extras = docs | |||
| commands = python -c "import src.cli.tox_helpers; src.cli.tox_helpers.markdownlint()" | |||
| allowlist_externals = bash | |||
| commands = | |||
There was a problem hiding this comment.
- Ooh, this is a bit wordy in the terminal. Could you add a function to
src/cli/tox_helpers.pyand use this in tox.ini? - Also please improve the error message: colon ":" is also accepted as a line ending.
- Additionally, I don't think the regex will catch nested lists due to
^-.
richardgreg
force-pushed
the
feature/changelog-validation
branch
2 times, most recently
from
068a2be to
de88d47
Compare
- Add CI check using grep to validate bullet points end with periods - Fix existing changelog entries missing periods
richardgreg
force-pushed
the
feature/changelog-validation
branch
from
de88d47 to
62eeef0
Compare
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.
🗒️ Description
🔗 Related Issues
Fixes #1183
✅ Checklist