Skip to content
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

CI check for changelog markdown syntax #2289

Open
Taneb opened this issue Feb 10, 2024 · 2 comments
Open

CI check for changelog markdown syntax #2289

Taneb opened this issue Feb 10, 2024 · 2 comments
Labels

Comments

@Taneb
Copy link
Member

Taneb commented Feb 10, 2024

As discussed in #2286, the changelog file often ends up with invalid markdown. We should add a CI check to ensure that it remains valid.

@jamesmckinna
Copy link
Contributor

@andreasabel echoing your comment on #2325

There's no reason for the CHANGELOG not to be under whitespace fixes.

Technically, trailing whitespace in .md files stands for <br/>, but I think this is a misfeature that shouldn't be used. (Use <br/> directly if you must.) Another reason I can think of that folks want to use tabs, but again, one can instead use spaces.

Would you have any good suggestions as to the best way to improve CI for the CHANGELOG to do (full) markdown validation?

@MatthewDaggitt
Copy link
Contributor

@jamesmckinna something like this should work: https://github.com/marketplace/actions/markdown-lint

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants