-
Notifications
You must be signed in to change notification settings - Fork 72
Fix markdown links and validate Markdown format #709
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
base: master
Are you sure you want to change the base?
Conversation
5347eae to
8da5aea
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds automated Markdown validation to the CI pipeline and fixes broken markdown links throughout the repository. The action requires pull request write permissions to comment on errors.
- Adds GitHub Actions workflow to validate Markdown files using
john0isaac/action-check-markdown - Fixes broken markdown links by correcting paths (removing incorrect
./prefixes and fixing wrong directory references) - Updates file extension reference from
.rstto.mdin external specification link
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| .github/workflows/markdown.yml | New workflow for automated Markdown validation with required permissions |
| README.md | Corrects markdown link paths by removing unnecessary ./ prefixes |
| .evergreen/secrets_handling/README.md | Fixes broken link to auth_oidc README |
| .evergreen/csfle/gcpkms/README.md | Corrects relative path to secrets_handling README |
| .evergreen/csfle/azurekms/README.md | Corrects relative path to secrets_handling README |
| .evergreen/aws_lambda/README.md | Fixes file extension and corrects directory name in link |
| .evergreen/auth_oidc/gcp/README.md | Corrects relative path to secrets_handling README |
| .evergreen/auth_oidc/azure/README.md | Corrects relative path to secrets_handling README |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Steven Silvester <[email protected]>
blink1073
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thank you!
I'm adding john0isaac/action-check-markdown to the CI to validate the markdown files.
This action requires additional permissions to comment on PR in case of error, see the error in https://github.com/mongodb-labs/drivers-evergreen-tools/actions/runs/19926577667