Skip to content

[DevOps] Create broken link tests for markdown files across all documentation folders #1691

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

Draft
wants to merge 3 commits into
base: dev
Choose a base branch
from
Draft

[DevOps] Create broken link tests for markdown files across all documentation folders #1691

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ee458ff
Initial plan for issue
Copilot Jun 12, 2025
dd2b1b9
Add comprehensive broken link tests for all markdown files
Copilot Jun 12, 2025
bccd13f
Refactor workflows and add -Markdown parameter per review feedback
Copilot Jun 19, 2025
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
26 changes: 26 additions & 0 deletions .github/workflows/documentation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: 'Documentation Tests'

on:
pull_request:
paths:
- 'docs/**'
- 'docs-mslearn/**'
- 'docs-wiki/**'
- '*.md'
- 'src/**/*.md'

jobs:
broken_links:
name: Broken Links
runs-on: Windows-latest
steps:
- name: Install and cache PowerShell modules
uses: potatoqualitee/[email protected]
with:
modules-to-cache: Pester
shell: pwsh
- uses: actions/checkout@v3
- name: Run Broken Links Test
shell: pwsh
run: |
src/scripts/Test-PowerShell.ps1 -Markdown
Comment on lines +14 to +26

Check warning

Code scanning / CodeQL

Workflow does not contain permissions Medium documentation

Actions job or workflow does not limit the permissions of the GITHUB_TOKEN. Consider setting an explicit permissions block, using the following as a minimal starting point: {contents: read}

Copilot Autofix

AI 4 months ago

To fix the issue, we will add a permissions block to the root of the workflow file. This block will specify the least privileges required for the workflow to function. Since the workflow only needs to read the repository contents to check for broken links, we will set contents: read. This ensures that the workflow has no write access to the repository.

The permissions block will be added at the root level, applying to all jobs in the workflow.

Suggested changeset 1
.github/workflows/documentation.yml

Autofix patch

Autofix patch
Run the following command in your local git repository to apply this patch
cat << 'EOF' | git apply
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
--- a/.github/workflows/documentation.yml
+++ b/.github/workflows/documentation.yml
@@ -11,2 +11,5 @@
 
+permissions:
+  contents: read
+
 jobs:
EOF
@@ -11,2 +11,5 @@

permissions:
contents: read

jobs:
Copilot is powered by AI and may make mistakes. Always verify output.
0 .github/workflows/dev.yml → .github/workflows/powershell.yml
View file
Open in desktop
File renamed without changes.
Loading