ci: add GitHub Action to enforce markdown style with pymarkdown#1416
Open
mattheliu wants to merge 1 commit intoPaddlePaddle:developfrom
Open
ci: add GitHub Action to enforce markdown style with pymarkdown#1416mattheliu wants to merge 1 commit intoPaddlePaddle:developfrom
mattheliu wants to merge 1 commit intoPaddlePaddle:developfrom
Conversation
|
Thanks for your contribution! |
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
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.
🧩 What does this PR do?
This PR introduces an automated Markdown quality gate for the ERNIE repository by adding a GitHub Actions workflow that runs
pymarkdownon every push and pull request affecting Markdown files.It ensures that all documentation changes comply with the project's formatting standards before being merged.
🚀 Why is this needed?
Documentation quality is critical for usability and long-term maintenance.
Before this PR, Markdown style checks were performed manually, which was error-prone and inconsistent.
This workflow provides:
🛠 What was added?
.github/workflows/markdown-lint.ymlpymarkdownas the Markdown linting enginepushandpull_requestfor all.mdfiles🧪 How is it tested?
The same command is used both locally and in CI: