Harden MkDocs generation and add PR validation checks #125
Workflow file for this run
This file contains hidden or 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: "Check for existence of a OCABundle.json file" | |
| on: | |
| pull_request: | |
| types: [opened, synchronize, reopened] | |
| jobs: | |
| oca_validation: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v6 | |
| - name: "Check file existence" | |
| id: check_files | |
| uses: andstor/file-existence-action@v3 | |
| with: | |
| files: "OCABundles/**/OCABundle.json" | |
| - name: Commit files | |
| if: steps.check_files.outputs.files_exists == 'true' | |
| run: | | |
| npm install -g ajv-cli | |
| ajv validate -s OCABundles/validators/schema.json -d 'OCABundles/**/OCABundle.json' | |
| docs_validation: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v6 | |
| - name: Setup Python | |
| uses: actions/setup-python@v6 | |
| with: | |
| python-version: 3.x | |
| - name: Install docs dependencies | |
| run: pip install mkdocs-material | |
| - name: Generate bundle indexes | |
| run: ./scripts/gen_ocabundlesjson.sh | |
| - name: Check generated indexes are up to date | |
| run: git diff --exit-code -- ocabundles.json ocabundleslist.json | |
| - name: Generate docs site assets | |
| run: ./scripts/genMkdocsSite.sh | |
| - name: Check mkdocs.yml generation is up to date | |
| run: git diff --exit-code -- mkdocs.yml | |
| - name: Validate docs build (strict) | |
| run: mkdocs build --strict |