Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added a check to current CI steps to check for updated docs #2509

Closed
wants to merge 13 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading
Loading