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

chore: fix failing markdown linting #5193

Merged
merged 1 commit into from
Aug 6, 2024
Merged

Conversation

voxpelli
Copy link
Member

@voxpelli voxpelli commented Aug 6, 2024

Follow up to #5186 / #5189. The release-please changelog entry didn't conform with the markdown linting, lets exclude it (at least for now)

@voxpelli voxpelli requested a review from a team August 6, 2024 18:27
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Compliance Checks

Thank you for your Pull Request! We have run several checks on this pull request in order to make sure it's suitable for merging into this project. The results are listed in the following section.

Issue Reference

In order to be considered for merging, the pull request description must refer to a specific issue number. This is described in our Contributing Guide. We are closing this pull request for now but you can update the pull request description and reopen the pull request.
The check is looking for a phrase similar to: "Fixes #XYZ" or "Resolves #XYZ" where XYZ is the issue number that this PR is meant to address.

@voxpelli voxpelli merged commit 7e7a2ec into main Aug 6, 2024
27 checks passed
@voxpelli voxpelli deleted the fix-failing-markdown-linting branch August 6, 2024 18:31
@DavidAnson
Copy link

DavidAnson commented Aug 8, 2024

@voxpelli, I'm curious why the project chose to turn off linting of CHANGELOG.md entirely instead of tweaking the 4 new * list item markers in #5189 to be consistent with the 451 existing - markers in that file? Has markdownlint let you down in some way?

(Edit to correct "listing"->"linting")

@voxpelli
Copy link
Member Author

voxpelli commented Aug 8, 2024

@DavidAnson Since those new items are generated by release-please and I wasn't sure if one could configure release-please to satisfy the linting

@DavidAnson
Copy link

Interesting. Sorry to bug folks. I use this repo as one of the backwards compatibility nightly tests for markdownlint, so I find out about violations pretty quickly. :)

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

Successfully merging this pull request may close these issues.

3 participants