Skip to content

Commit

Permalink
Add markdown linting GH Action
Browse files Browse the repository at this point in the history
  • Loading branch information
wvanhed committed Jun 18, 2024
1 parent e41277b commit aaf87b8
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions .github/workflows/lint-markdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Lint markdown files
# From: https://github.com/marketplace/actions/markdown-linting-action
# Overview of markdownlint: https://github.com/DavidAnson/markdownlint
# VSC plugin: https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint

on:
push:
branches: [ "main", "develop" ]

permissions:
contents: read

jobs:
lint-changelog:
name: Lint markdown files
runs-on: ubuntu-latest
steps:
- name: Check out code
uses: actions/checkout@v4
- name: Lint markdown
uses: docker://avtodev/markdown-lint:v1 # fastest way
with:
# rules: ".changelog-rules.js"
# config: ".markdownlint.yml"
args: "./README.md ./changelog.md"
# ignore: './one_file.md ./another_file.md' # multiple files must be separated with single space

0 comments on commit aaf87b8

Please sign in to comment.