diff --git a/.github/workflows/pull-request-checks.yml b/.github/workflows/pull-request-checks.yml index 355d05f..06b8d9b 100644 --- a/.github/workflows/pull-request-checks.yml +++ b/.github/workflows/pull-request-checks.yml @@ -1,16 +1,22 @@ name: "Pull Request Checks" on: pull_request jobs: - # Enforce the update of the changelog file + # Ensure that the changelog file has been updated in this PR check-changelog-change: runs-on: ubuntu-latest steps: - uses: dangoslen/changelog-enforcer@v3 - # Ensure markdown files are formatted consistently + # Ensure that markdown files are formatted consistently (according to .markdownlint.yml) lint-markdown-files: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 - - uses: xt0rted/markdownlint-problem-matcher@v2 - - run: npm install -g markdownlint-cli - - run: markdownlint **/*.md + - name: Fetch the Wikimate code into the Actions runner + uses: actions/checkout@v3 + - name: Install the markdownlint-problem-matcher action + uses: xt0rted/markdownlint-problem-matcher@v2 + - name: Install markdownlint-cli + run: npm install -g markdownlint-cli + - name: List files that will be processed + run: npx --silent glob '**/*.md' + - name: Run markdownlint + run: markdownlint '**/*.md' diff --git a/.markdownlint.yml b/.markdownlint.yml index 71fb1ef..f2c7554 100644 --- a/.markdownlint.yml +++ b/.markdownlint.yml @@ -27,3 +27,8 @@ MD024: MD026: # Trailing punctuation characters not allowed in headings punctuation: ",;:!" + +# MD052/reference-links-images +MD052: + # Validate shortcut-style links + shortcut_syntax: true diff --git a/CHANGELOG.md b/CHANGELOG.md index 23a015f..d3f5a93 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,8 +11,10 @@ and [Keep a Changelog](http://keepachangelog.com/). - Clarified instructions in `GOVERNANCE.md` for releasing new versions ([#157]) - Updated versions of GitHub Actions dependencies ([#161]) +- Fixed markdownlint execution in the CI pipeline ([#154]) +[#154]: https://github.com/hamstar/Wikimate/pull/154 [#157]: https://github.com/hamstar/Wikimate/pull/157 [#161]: https://github.com/hamstar/Wikimate/pull/161