Skip to content

Commit

Permalink
feat: adds markdown linting to CI
Browse files Browse the repository at this point in the history
Signed-off-by: Jennifer Power <[email protected]>
  • Loading branch information
jpower432 committed Oct 3, 2024
1 parent 92d0713 commit 9035ccd
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 2 deletions.
26 changes: 26 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Lint Markdown

on:
pull_request:
branches:
- main
paths:
- '**/*.md'
- '.markdownlint-cli2.yaml'

permissions:
contents: read

jobs:
markdown-lint:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
with:
fetch-depth: 0

- name: Lint Markdown
uses: DavidAnson/markdownlint-cli2-action@db43aef879112c3119a410d69f66701e0d530809 # v17.0.0
with:
globs: '**/*.md'
8 changes: 6 additions & 2 deletions .github/workflows/proposals.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ on:
pull_request:
branches:
- main

permissions:
contents: read

jobs:
validate:
runs-on: ubuntu-latest
Expand All @@ -11,10 +15,10 @@ jobs:
run: |
git config --global core.autocrlf false
- uses: actions/checkout@v4
- uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0

- name: Set up Python
uses: actions/setup-python@v5
uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5.2.0
with:
python-version: '3.11'
cache: 'pip'
Expand Down
15 changes: 15 additions & 0 deletions .markdownlint-cli2.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
config:
line-length: false
no-emphasis-as-heading: false
code-block-style: false
no-inline-html: false
ul-style: false
no-multiple-blanks: false
no-alt-text: false
no-bare-urls: false
globs:
- "**/*.md"
ignores:
- ".github/**"
- "proposals/**"
- ".trestle/**"

0 comments on commit 9035ccd

Please sign in to comment.