ci: Run docs generation on all changes #65
Conversation
petercrocker
commented
Jan 28, 2026
petercrocker
commented
- Remove documentation file filter from documentation job
- Run invoke docs.generate on every CI run, not just when docs files change
- Update markdownlint configuration with improved formatting and comments
- Remove documentation file filter from documentation job - Run invoke docs.generate on every CI run, not just when docs files change - Update markdownlint configuration with improved formatting and comments
Deploying schema-library with
|
| Latest commit: |
0c7c76d
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://8a08e395.schema-library.pages.dev |
| Branch Preview URL: | https://ci-run-docs-generation-on-al.schema-library.pages.dev |
| id: push | ||
| run: | | ||
| git config --global user.name "documentator" | ||
| git config --global user.email "[email protected]" |
| @@ -1,5 +1,22 @@ | |||
| --- | |||
| # yamllint disable rule:truthy rule:truthy rule:line-length | |||
|
|
|||
There was a problem hiding this comment.
Probably bit excessive to have this inline comment, but no big deal
|
@fatih-acar could use your £0.02 if this is a good approach in the CI pipeline of how to regenerate the docs when someone changes a schema in this repo, and push those docs file changes as part of the CI pipeline run? |
I don't like this pattern (we already have it in other places... I know). I think it's better to have a job that generates the docs and checks if there are diffs, then fail the job if there are any and let the human commit the generated docs instead? It avoids wild commits from bots with random tokens (and we tend to forget about the bot commits at some point). |
