Skip to content

Commit 04fff16

Browse files
Use markdownlint for generated documentation
Replace the broad Super-Linter invocation with markdownlint-cli2 for the generated Markdown output. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent 667a5b2 commit 04fff16

1 file changed

Lines changed: 4 additions & 36 deletions

File tree

.github/workflows/Build-Docs.yml

Lines changed: 4 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -78,39 +78,7 @@ jobs:
7878
}
7979
8080
- name: Lint documentation
81-
id: super-linter
82-
uses: super-linter/super-linter/slim@4ce20838b8ab83717e78138c5b3a1407148e0918 # v8.7.0
83-
env:
84-
RUN_LOCAL: true
85-
DEFAULT_BRANCH: main
86-
DEFAULT_WORKSPACE: ${{ fromJson(inputs.Settings).WorkingDirectory }}
87-
FILTER_REGEX_INCLUDE: ${{ fromJson(inputs.Settings).WorkingDirectory }}/outputs/docs
88-
ENABLE_GITHUB_ACTIONS_GROUP_TITLE: true
89-
GITHUB_TOKEN: ${{ github.token }}
90-
VALIDATE_ALL_CODEBASE: true
91-
VALIDATE_BIOME_FORMAT: false
92-
VALIDATE_BIOME_LINT: false
93-
VALIDATE_GITHUB_ACTIONS_ZIZMOR: false
94-
VALIDATE_GITLEAKS: false
95-
VALIDATE_JSCPD: false
96-
VALIDATE_JSON_PRETTIER: false
97-
VALIDATE_MARKDOWN_PRETTIER: false
98-
VALIDATE_YAML_PRETTIER: false
99-
ENABLE_GITHUB_ACTIONS_STEP_SUMMARY: false
100-
USE_FIND_ALGORITHM: true
101-
SAVE_SUPER_LINTER_SUMMARY: true
102-
103-
- name: Post super-linter summary
104-
if: failure() || fromJson(inputs.Settings).Build.Docs.ShowSummaryOnSuccess == true
105-
shell: pwsh
106-
env:
107-
SUPER_LINTER_OUTCOME: ${{ steps.super-linter.outcome }}
108-
run: |
109-
$summaryPath = Join-Path $env:GITHUB_WORKSPACE 'super-linter-output' 'super-linter-summary.md'
110-
Get-Content $summaryPath | Out-File -FilePath $env:GITHUB_STEP_SUMMARY -Encoding utf8
111-
112-
$failed = $env:SUPER_LINTER_OUTCOME -eq 'failure'
113-
if ($failed) {
114-
Write-Host "::error::Super-linter found issues. Please review the summary above."
115-
exit 1
116-
}
81+
uses: DavidAnson/markdownlint-cli2-action@83c6b49590003d85b71ea0e478b36aa0a9bb3cd4 # main
82+
with:
83+
config: .github/linters/.markdown-lint.yml
84+
globs: ${{ fromJson(inputs.Settings).WorkingDirectory }}/outputs/docs/**/*.{md,markdown}

0 commit comments

Comments
 (0)