Skip to content

Commit d54615e

Browse files
chore: modifying doc check enforcement
1 parent 9d25098 commit d54615e

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

.github/workflows/reusable-build-test-release.yml

+20-1
Original file line numberDiff line numberDiff line change
@@ -326,6 +326,8 @@ jobs:
326326
runs-on: ubuntu-latest
327327
container:
328328
image: python:3.9
329+
outputs:
330+
status: ${{ steps.validate.outputs.status }}
329331
steps:
330332
- uses: actions/checkout@v4
331333
with:
@@ -337,7 +339,24 @@ jobs:
337339
pip install mkdocs==1.6.1 mkdocs-material==9.6.9 poetry
338340
- name: validate
339341
run: |
340-
poetry run mkdocs build --strict
342+
if poetry run mkdocs build --strict; then
343+
echo "status=success" >> "$GITHUB_OUTPUT"
344+
echo "status :: success"
345+
else
346+
echo "status=failure" >> "$GITHUB_OUTPUT"
347+
echo "status :: failure"
348+
fi
349+
350+
enforce-docs-checks:
351+
runs-on: ubuntu-latest
352+
needs: validate-docs-change
353+
if: github.ref == 'refs/heads/main' || github.event_name == 'pull_request'
354+
steps:
355+
- name: Fail if validate-docs-change failed
356+
run: |
357+
if [ "${{ needs.validate-docs-change.outputs.status }}" == "failure" ]; then
358+
exit 1
359+
fi
341360
342361
fossa-scan:
343362
runs-on: ubuntu-latest

0 commit comments

Comments
 (0)