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 16, 2023
1 parent 05de364 commit 9939812
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions .github/workflows/markdown_tools.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Markdown tools
on:
workflow_dispatch:

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

jobs:
markdownlint:
name: MarkdownLint

permissions:
contents: read
pull-requests: read

runs-on: ubuntu-latest

steps:
- name: Checkout repo
uses: actions/checkout@v4
- name: Install Node
uses: actions/setup-node@v4
with:
node-version: 18
- name: Install MarkdownLint
run: npm install -g markdownlint-cli
- name: Checking markdown
run: markdownlint .

0 comments on commit 9939812

Please sign in to comment.