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

Added a GitHub Actions workflow to check and automatically fix Markdown lint issues on pull requests. #12588

Closed
wants to merge 2 commits into from

Conversation

Brijeshthummar02
Copy link

What I did

  • Configured markdownlint with custom rules, including support for Go.  
  • The workflow runs on PRs, fixes any issues, and commits the changes back.  
  • Helps keep Markdown files clean and consistent without manual effort.

References #12587

Related issue

(not mandatory) A picture of a cute animal, if possible in relation to what you did

@Brijeshthummar02 Brijeshthummar02 requested a review from a team as a code owner February 26, 2025 14:03
@glours
Copy link
Contributor

glours commented Feb 26, 2025

Hey @Brijeshthummar02
Why did you create a new PR and you didn't add your GHA workflow in the previous one?

sorry for the close and reopen, I miss-clicked

@glours glours closed this Feb 26, 2025
@glours glours reopened this Feb 26, 2025
@Brijeshthummar02
Copy link
Author

@glours want to keep both separate and was easy for me to make changes as need by Reviewers.

@Brijeshthummar02
Copy link
Author

@glours if u say so i can close this and add this files to the #12587 ?

@glours
Copy link
Contributor

glours commented Feb 26, 2025

@Brijeshthummar02 yes please it's easier on our side to keep everything in one PR

Copy link
Contributor

@ndeloof ndeloof left a comment

Choose a reason for hiding this comment

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

no "auto-fix", please. Also the changes here apply to generated markdown, so this would make the repository HEAD inconsistent.
Keep related changes in a single PR if possible

@ndeloof ndeloof closed this Feb 26, 2025
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