-
Notifications
You must be signed in to change notification settings - Fork 883
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Felix Fontein <felix@fontein.de>
- Loading branch information
1 parent
524e16b
commit d9fc30f
Showing
1 changed file
with
38 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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') |