2 files changed, 21 insertions, 0 deletions
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
index cdd881fbe1..2cc5a525a6 100644
--- a/.github/workflows/tests.yml
+++ b/.github/workflows/tests.yml
@@ -21,6 +21,7 @@ jobs:
trial: ${{ !startsWith(github.ref, 'refs/pull/') || steps.filter.outputs.trial }}
integration: ${{ !startsWith(github.ref, 'refs/pull/') || steps.filter.outputs.integration }}
linting: ${{ !startsWith(github.ref, 'refs/pull/') || steps.filter.outputs.linting }}
+ linting_readme: ${{ !startsWith(github.ref, 'refs/pull/') || steps.filter.outputs.linting_readme }}
steps:
- uses: dorny/paths-filter@v3
id: filter
@@ -72,6 +73,9 @@ jobs:
- 'pyproject.toml'
- 'poetry.lock'
- '.github/workflows/tests.yml'
+
+ linting_readme:
+ - 'README.rst'
check-sampleconfig:
runs-on: ubuntu-latest
@@ -269,6 +273,20 @@ jobs:
- run: cargo fmt --check
+ # This is to detect issues with the rst file, which can otherwise cause issues
+ # when uploading packages to PyPi.
+ lint-readme:
+ runs-on: ubuntu-latest
+ needs: changes
+ if: ${{ needs.changes.outputs.linting_readme == 'true' }}
+ steps:
+ - uses: actions/checkout@v4
+ - uses: actions/setup-python@v5
+ with:
+ python-version: "3.x"
+ - run: "pip install rstcheck"
+ - run: "rstcheck --report-level=WARNING README.rst"
+
# Dummy step to gate other tests on without repeating the whole list
linting-done:
if: ${{ !cancelled() }} # Run this even if prior jobs were skipped
@@ -284,6 +302,7 @@ jobs:
- lint-clippy
- lint-clippy-nightly
- lint-rustfmt
+ - lint-readme
runs-on: ubuntu-latest
steps:
- uses: matrix-org/done-action@v2
@@ -301,6 +320,7 @@ jobs:
lint-clippy
lint-clippy-nightly
lint-rustfmt
+ lint-readme
calculate-test-jobs:
diff --git a/changelog.d/17367.misc b/changelog.d/17367.misc
new file mode 100644
index 0000000000..361731b8ae
--- /dev/null
+++ b/changelog.d/17367.misc
@@ -0,0 +1 @@
+Add CI check for the README.
\ No newline at end of file
|
