Skip to content

Commit

Permalink
Add a rst syntax check to avoid invalid syntax in the future
Browse files Browse the repository at this point in the history
- Check rst passes
```
crl-m1:flake8-bugbear cooper$ /tmp/tf/bin/rstcheck README.rst
Success! No issues detected.
crl-m1:flake8-bugbear cooper$ echo $?
0
```
- Chcek we have valid yaml
```
crl-m1:flake8-bugbear cooper$ cat .github/workflows/rst_check.yml | yq > /dev/null
crl-m1:flake8-bugbear cooper$ echo $?
0
```
  • Loading branch information
cooperlees committed Jan 15, 2024
1 parent 1d63713 commit b78cf05
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/rst_check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: rst_check

on: [push, pull_request]

jobs:
build:
steps:
- uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v5

- name: Update pip and setuptools
run: |
python -m pip install --upgrade pip setuptools
- name: Install rstcheck
run: |
python -m pip install rstcheck
- name: Run rstcheck
run: |
rstcheck README.rst

0 comments on commit b78cf05

Please sign in to comment.