Skip to content

Switch to using GitHub action to verify PRs for broken markdown links #17281

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.

Sign up for GitHub

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

Merged
daxian-dbw merged 5 commits into from
May 9, 2022
+24 −13
Merged

Switch to using GitHub action to verify PRs for broken markdown links #17281

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1d38094
switch to using github action to verify PRs for markdown links
TravisEz13 May 6, 2022
215e1fa
break a link to see if it works
TravisEz13 May 6, 2022
ece98bc
fix broken link
TravisEz13 May 6, 2022
4a30950
Revert "break a link to see if it works"
TravisEz13 May 6, 2022
75d6bf1
Copy allowed failures from previous tests
TravisEz13 May 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/markdown-link/config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"aliveStatusCodes": [504, 503, 403, 200]
}
20 changes: 20 additions & 0 deletions .github/workflows/markdownLink.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
on:
pull_request:
branches:
- master
- 'release/**'
paths:
- '**.md'

name: Check links for modified files
jobs:
markdown-link-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
use-quiet-mode: 'yes'
use-verbose-mode: 'yes'
check-modified-files-only: 'yes'
config-file: .github/workflows/markdown-link/config.json
12 changes: 0 additions & 12 deletions .vsts-ci/misc-analysis.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,3 @@ stages:
dependsOn: []
jobs:
- template: ./misc-analysis/mdSpell.yml
- stage: markdown_link
displayName: Markdown Link
dependsOn: []
jobs:
- template: ./misc-analysis/generateMarkdownMatrix.yml
parameters:
jobName: generateMatrix
taskName: matrixTask
- template: ./misc-analysis/markdown.yml
parameters:
matrix: $[ dependencies.generateMatrix.outputs['matrixTask.matrix'] ]
dependsOn: generateMatrix
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ For more information on how and why we built this dashboard, check out this [blo

## Discussions

[GitHub Discussions](https://docs.github.com/en/free-pro-team@latest/discussions/quickstart) is a feature to enable fluid and open discussions within the community
[GitHub Discussions](https://docs.github.com/discussions/quickstart) is a feature to enable fluid and open discussions within the community
for topics that are not related to code, unlike issues.

This is an experiment we are trying in our repositories to see if it helps move discussions out of issues so that issues remain actionable by the team or members of the community.
Expand Down