Skip to content

Commit

Permalink
Create Markdown reviewdog GitHub Actions workflow
Browse files Browse the repository at this point in the history
> Run markdownlint with reviewdog [1] [2]

> markdownlint is a static analysis tool for Node.js [2]
> with a library of rules to enforce standards
> and consistency for Markdown files.
> It was inspired by - and heavily influenced by
> - Mark Harrison's markdownlint for Ruby. [3]
> The initial rules, rule documentation,
> and test cases came directly from that project.

[1]: https://github.com/reviewdog/action-markdownlint
[2]: https://github.com/DavidAnson/markdownlint
[3]: https://github.com/markdownlint/markdownlint
  • Loading branch information
torrocus committed Nov 13, 2023
1 parent cc0b602 commit 3d1e90e
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/markdown_reviewdog.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Markdown reviewdog
on:
pull_request:
types: [opened,synchronize]

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
markdownlint:
name: Markdown linter
runs-on: ubuntu-latest
steps:
- name: Check out code
uses: actions/checkout@v4
- name: Check Markdown
uses: reviewdog/action-markdownlint@v0
with:
fail_on_error: true
filter_mode: diff_context
level: error
reporter: github-pr-check

0 comments on commit 3d1e90e

Please sign in to comment.