chore: Add Markdownlint checking and CI #541
There are no files selected for viewing
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| { | ||
| "problemMatcher": [ | ||
| { | ||
| "owner": "markdownlint", | ||
| "pattern": [ | ||
| { | ||
| "regexp": "^([^:]*):(\\d+):?(\\d+)?\\s([\\w-\\/]*)\\s(.*)$", | ||
| "file": 1, | ||
| "line": 2, | ||
| "column": 3, | ||
| "code": 4, | ||
| "message": 5 | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| name: Markdownlint Translations | ||
|
|
||
| on: | ||
| pull_request: | ||
| branches: | ||
| - translations | ||
| push: | ||
| branches: | ||
| - translations | ||
|
|
||
| jobs: | ||
| see_if_should_skip: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| outputs: | ||
| should_skip: ${{ steps.skip_check.outputs.should_skip }} | ||
| steps: | ||
| - id: skip_check | ||
| uses: fkirc/skip-duplicate-actions@36feb0d8d062137530c2e00bd278d138fe191289 | ||
| with: | ||
| cancel_others: 'false' | ||
| github_token: ${{ github.token }} | ||
| paths: '["translations/**/*.md", "package*.json", ".markdownlint.json", ".github/workflows/markdownlint-translations.yml", ".github/workflows/markdownlint-problem-matcher.json"]' | ||
| lint: | ||
| runs-on: ubuntu-latest | ||
| needs: see_if_should_skip | ||
| if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }} | ||
| steps: | ||
| - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f | ||
|
|
||
| - name: Get npm cache directory | ||
| id: npm-cache | ||
| run: | | ||
| echo "::set-output name=dir::$(npm config get cache)" | ||
|
|
||
| - name: Cache node modules | ||
| uses: actions/cache@0781355a23dac32fd3bac414512f4b903437991a | ||
| with: | ||
| path: ${{ steps.npm-cache.outputs.dir }} | ||
| key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} | ||
| restore-keys: | | ||
| ${{ runner.os }}-node- | ||
|
|
||
| - name: Install dependencies | ||
| run: npm ci | ||
|
|
||
| - name: Run Markdownlint | ||
| run: | | ||
| echo "::add-matcher::.github/workflows/markdownlint-problem-matcher.json" | ||
| npm run markdownlint:translations |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| name: Markdownlint | ||
|
|
||
| on: | ||
| pull_request: | ||
| branches-ignore: | ||
| - translations | ||
| push: | ||
| branches: | ||
| - main | ||
|
|
||
| jobs: | ||
| see_if_should_skip: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| outputs: | ||
| should_skip: ${{ steps.skip_check.outputs.should_skip }} | ||
| steps: | ||
| - id: skip_check | ||
| uses: fkirc/skip-duplicate-actions@36feb0d8d062137530c2e00bd278d138fe191289 | ||
| with: | ||
| cancel_others: 'false' | ||
| github_token: ${{ github.token }} | ||
| paths: '["**/*.md", "!translations/**", "package*.json", ".markdownlint.json", ".github/workflows/markdownlint.yml", ".github/workflows/markdownlint-problem-matcher.json"]' | ||
| paths_ignore: '["translations/**"]' | ||
| lint: | ||
| runs-on: ubuntu-latest | ||
| needs: see_if_should_skip | ||
| if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }} | ||
| steps: | ||
| - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f | ||
|
|
||
| - name: Get npm cache directory | ||
| id: npm-cache | ||
| run: | | ||
| echo "::set-output name=dir::$(npm config get cache)" | ||
|
|
||
| - name: Cache node modules | ||
| uses: actions/cache@0781355a23dac32fd3bac414512f4b903437991a | ||
| with: | ||
| path: ${{ steps.npm-cache.outputs.dir }} | ||
| key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} | ||
| restore-keys: | | ||
| ${{ runner.os }}-node- | ||
|
|
||
| - name: Install dependencies | ||
| run: npm ci | ||
|
|
||
| - name: Run Markdownlint | ||
| run: | | ||
| echo "::add-matcher::.github/workflows/markdownlint-problem-matcher.json" | ||
|
There was a problem hiding this comment. This registers the problem matcher file so that PRs get in-line comments on the file tab if the markdownlint job puts any issues to the jobs console |
||
| npm run markdownlint | ||
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| { | ||
| "default": true, | ||
| "MD001": false, | ||
| "MD003": false, | ||
| "MD004": false, | ||
| "MD005": false, | ||
| "MD007": false, | ||
| "MD009": false, | ||
| "MD010": false, | ||
| "MD012": false, | ||
| "MD013": false, | ||
| "MD014": false, | ||
| "MD019": false, | ||
| "MD020": false, | ||
| "MD022": false, | ||
| "MD023": false, | ||
| "MD024": false, | ||
| "MD025": false, | ||
| "MD026": false, | ||
| "MD029": false, | ||
| "MD030": false, | ||
| "MD031": false, | ||
| "MD032": false, | ||
| "MD033": false, | ||
| "MD034": false, | ||
| "MD036": false, | ||
| "MD037": false, | ||
| "MD038": false, | ||
| "MD039": false, | ||
| "MD040": false, | ||
| "MD041": false, | ||
| "MD042": false, | ||
| "MD045": false, | ||
| "MD046": false, | ||
| "MD047": false | ||
| } |
This file contains 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we rename this to something other than "lint" to avoid confusion with the JavaScript-linting job? Maybe
mdlintormarkdown-lint? 🤷♂️There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Figured it was better to use the same job name so it stays a required check