Skip to content

Commit

Permalink
doc test
Browse files Browse the repository at this point in the history
  • Loading branch information
leecchh committed Apr 29, 2024
1 parent 8ca7af0 commit 2fac840
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions .github/workflows/doc_test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Documentation Check

on:
pull_request:
branches:
- main

jobs:
check-docs:
runs-on: ubuntu-latest
steps:
- name: Check out code
uses: actions/checkout@v2

- name: Install dependencies
run: |
sudo apt-get update
sudo apt-get install -y coreutils
- name: Run documentation script
run: |
chmod +x ./scripts/docgen.sh
./scripts/docgen.sh
- name: Check for changes
run: |
if [[ `git status --porcelain` ]]; then
echo "Documentation is not up to date. Please update before merging."
exit 1 # Fail the job to indicate documentation is not up-to-date
else
echo "Documentation is up-to-date."
fi

0 comments on commit 2fac840

Please sign in to comment.