Skip to content

Commit

Permalink
Add CI pipeline job to check syntax with rstcheck
Browse files Browse the repository at this point in the history
  • Loading branch information
mmerklinger committed Mar 13, 2024
1 parent 0e43703 commit a0f7422
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 0 deletions.
16 changes: 16 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,22 @@ on:
pull_request:

jobs:
syntax-check:
name: Check syntax
runs-on: ubuntu-latest
container: python:3.11-slim
steps:
- name: Checkout repository
uses: actions/checkout@v3
- name: Create virtual environment
run: |
python -m venv venv
. venv/bin/activate
pip install -r requirements.txt
- name: Syntax check
run: |
. venv/bin/activate
rstcheck --recursive --ignore-directives "tabs" fido2/ hsm/ nethsm/ nextbox/ nitrokey3/ nitropad/ nitropc/ nitrophone/ nitrowall/ pro/ software/ start/ storage/ u2f/
build-error-check:
name: Check build error
runs-on: ubuntu-latest
Expand Down
2 changes: 2 additions & 0 deletions .rstcheck.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[rstcheck]
ignore_directives=tabs
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ MarkupSafe==2.1.2
packaging==23.1
Pygments==2.15.1
requests==2.30.0
rstcheck==6.2.0
snowballstemmer==2.2.0
soupsieve==2.4.1
Sphinx==6.2.1
Expand Down

0 comments on commit a0f7422

Please sign in to comment.