Skip to content

Commit

Permalink
Add workflow for rstcheck and mdl.
Browse files Browse the repository at this point in the history
Signed-off-by: Felix Fontein <felix@fontein.de>
  • Loading branch information
felixfontein committed Sep 16, 2023
1 parent 524e16b commit d9fc30f
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: "Docs"

on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]
# Only consider changes to documentation
paths:
- '**/*.md'
- '**/*.rst'
- '**/*.txt'
schedule:
- cron: '25 6 * * 3'

permissions:
contents: read

jobs:
documentation:
name: Lint RST and MD files
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0

- name: Install rstcheck
run: pip install rstcheck

- name: Run rstcheck on all RST files
run: rstcheck $(find -name '*.rst')

- name: Install markdownlint
run: sudo gem install mdl

- name: Run mdl on all MD files
run: mdl $(find -name '*.md')

0 comments on commit d9fc30f

Please sign in to comment.