ci: Added workflow for checking broken links in Markdown files #591
Conversation
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
Rohini-Microsoft
requested review from
Avijit-Microsoft,
Prajwal-Microsoft,
Roopan-Microsoft,
Vinay-Microsoft and
aniaroramsft
as code owners
Contributor
There was a problem hiding this comment.
Pull Request Overview
Adds a new GitHub Actions workflow to automatically check for broken links in Markdown files on pull requests and via manual dispatch.
- Detects changed Markdown files in a PR and runs lychee against them.
- Allows a manual trigger to run lychee against all Markdown files in the repo.
Comments suppressed due to low confidence (2)
.github/workflows/broken-links-checker.yml:27
- [nitpick] Consider pinning the
tj-actions/changed-filesaction to its semantic version tag (e.g.,@v46) instead of a raw commit SHA for clearer maintenance and automatic updates.
uses: tj-actions/changed-files@ed68ef82c095e0d48ec87eccea555d944a631a4c # v46
.github/workflows/broken-links-checker.yml:37
- [nitpick] The lychee Action invocation is duplicated for PR and manual triggers. Consider extracting this into a reusable workflow or composite action to reduce duplication and simplify future updates.
uses: lycheeverse/lychee-action@v2.4.1
Vamshi-Microsoft
changed the title
Roopan-Microsoft
approved these changes
Jul 8, 2025
|
🎉 This PR is included in version 1.5.2 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
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.
This pull request adds a new GitHub Actions workflow to check for broken links in markdown files. The workflow is designed to run on pull requests and manual triggers, ensuring that markdown files are free of broken links.
Workflow addition:
.github/workflows/broken-links-checker.yml: Introduced a new workflow named "Broken Link Checker" that uses the lychee-action to validate links in markdown files. It checks only changed markdown files for pull requests and all markdown files for manual triggers.
Golden Path Validation
Deployment Validation
What to Check
Verify that the following are valid
Other Information