Add linting for RST and MD files #2
Workflow file for this run
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
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: Validate RST 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: gem install --local mdl | |
- name: Run mdl on all MD files | |
run: mdl $(find -name '*.md') |