Skip to content
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.

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

Fix markdownlint execution in the CI pipeline #154

Merged
merged 5 commits into from
Oct 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 12 additions & 6 deletions .github/workflows/pull-request-checks.yml
Original file line number Diff line number Diff line change
@@ -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'
5 changes: 5 additions & 0 deletions .markdownlint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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])

<!-- Reference link URLs for this release section -->
[#154]: https://github.com/hamstar/Wikimate/pull/154
[#157]: https://github.com/hamstar/Wikimate/pull/157
[#161]: https://github.com/hamstar/Wikimate/pull/161

Expand Down