Skip to content
Ensure schema is up to date

Fix documentation inconsistencies and typos across documentation files #867

Sign in to view logs

Fix documentation inconsistencies and typos across documentation files

Fix documentation inconsistencies and typos across documentation files #867

Workflow file for this run

.github/workflows/test_schema.yaml at 5fcb842
name: Ensure schema is up to date
on:
pull_request:
branches:
- main
jobs:
upload_config_schema:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- run: pip install pydantic pydantic-partial pyyaml yamlcore
- run: python3 src/penguin/penguin_config/gen_docs.py docs > schema_doc.md
# Ensure generated schema_doc.md matches the one in the repo at docs/schema_doc.md
- run: |
if ! diff schema_doc.md docs/schema_doc.md; then
echo "Config schema is out of date. Please run 'python3 src/penguin/penguin_config/gen_docs.py docs > docs/schema_doc.md && git add docs/schema_doc.md' and push a commit with the updated schema."
exit 1
fi