Skip to content

Commit

Permalink
Add CI step to check for documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
Sunay Sanghani authored and Sunay Sanghani committed Jul 12, 2024
1 parent 9d2c6b2 commit 329df37
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 0 deletions.
28 changes: 28 additions & 0 deletions .github/workflows/check_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Check Documentation

on:
push:
branches:
- main
pull_request:
branches:
- main

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

- name: Setup Python
uses: actions/setup-python@v2
with:
python-version: 3.8

- name: Install dependencies
run: |
pip install -r requirements.txt
- name: Check for documentation updates
run: ./scripts/check_docs.sh
8 changes: 8 additions & 0 deletions ci/check_docs.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
set -e

if git diff --quiet HEAD^ HEAD -- docs/; then
echo "Documentation has not been updated."
exit 1
else
echo "Documentation is up-to-date."
fi

0 comments on commit 329df37

Please sign in to comment.