Skip to content

Commit 474f158

Browse files
Use markdownlint for generated docs
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent fb6d2a5 commit 474f158

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
@@ -10,7 +10,6 @@ on:
1010

1111
permissions:
1212
contents: read # to checkout the repo
13-
statuses: write # to create commit status
1413

1514
jobs:
1615
Build-Docs:
@@ -79,38 +78,7 @@ jobs:
7978
}
8079
8180
- name: Lint documentation
82-
id: super-linter
83-
uses: super-linter/super-linter/slim@4ce20838b8ab83717e78138c5b3a1407148e0918 # v8.7.0
84-
env:
85-
RUN_LOCAL: true
86-
DEFAULT_BRANCH: main
87-
DEFAULT_WORKSPACE: ${{ fromJson(inputs.Settings).WorkingDirectory }}
88-
FILTER_REGEX_INCLUDE: ${{ fromJson(inputs.Settings).WorkingDirectory }}/outputs/docs
89-
ENABLE_GITHUB_ACTIONS_GROUP_TITLE: true
90-
GITHUB_TOKEN: ${{ github.token }}
91-
VALIDATE_ALL_CODEBASE: true
92-
VALIDATE_BIOME_FORMAT: false
93-
VALIDATE_BIOME_LINT: false
94-
VALIDATE_GITHUB_ACTIONS_ZIZMOR: false
95-
VALIDATE_GITLEAKS: false
96-
VALIDATE_JSCPD: false
97-
VALIDATE_JSON_PRETTIER: false
98-
VALIDATE_MARKDOWN_PRETTIER: false
99-
VALIDATE_YAML_PRETTIER: false
100-
ENABLE_GITHUB_ACTIONS_STEP_SUMMARY: false
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@28a7e8bdb81fd8ad675883de92c758ab78e0ce10 # v24
82+
with:
83+
config: .github/linters/.markdown-lint.yml
84+
globs: ${{ fromJson(inputs.Settings).WorkingDirectory }}/outputs/docs/**/*.md

0 commit comments

Comments
 (0)