Move Documentation CI #1
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |