mirror of
https://github.com/getsops/sops.git
synced 2026-02-05 12:45:21 +01:00
Add workflow for rstcheck and mdl.
Signed-off-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
committed by
Hidde Beydals
parent
968e9a551b
commit
7b289aa044
38
.github/workflows/docs.yml
vendored
Normal file
38
.github/workflows/docs.yml
vendored
Normal file
@@ -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')
|
||||
Reference in New Issue
Block a user