[AutoDocs] Update Platform Docs#3626
Merged
Merged
Conversation
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
octo-sts-2
Bot
added
automated
documentation
✅ Deploy Preview for ornate-narwhal-088216 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
matthewhelmke
approved these changes
Jul 23, 2026
matthewhelmke
added a commit
that referenced
this pull request
Jul 23, 2026
## Problem The AutoDocs PR [#3626](#3626) failed the required `pre-commit` check — a job that has always passed. The failing hook is `end-of-file-fixer`, on four files: ``` static/api.json static/api-v1.json static/api-v2alpha1.json static/api-v2beta1.json ``` These are OpenAPI specs that `.github/actions/integrate-platform-docs` syncs verbatim from cloud storage (`gsutil ... enforce-openapi/api*.json static/`), and the generator emits them **without a trailing newline**. They've always lacked one; prior AutoDocs runs simply didn't change them, so they stayed out of the pre-commit diff. This run updated the spec, pulling them into the changed-file set, and `end-of-file-fixer` rewrote them — failing the check on content the docs team can't hand-fix (the next sync clobbers any newline we add). ## Fix Exclude `static/api*.json` from `trailing-whitespace` and `end-of-file-fixer`, mirroring the existing `chainctl-docs` exclusion — same rationale: generated, synced verbatim, fixes don't survive the next sync. Each `exclude` becomes a verbose (`(?x)`) regex covering both paths. ## Verification - Regex tested against the four files plus near-misses (`static/apidocs/x.json`, `static/api.json.bak`) — matches only the intended specs, no over-match. - `pre-commit run end-of-file-fixer --files static/api*.json README.md` now passes (the specs are skipped; normal files still checked). - Config-only change; `check-yaml` and the full local hook suite pass. Once this merges, the next AutoDocs run (or a rebase of #3626 onto updated `main`) will pass the check. --- Created in collaboration with Claude Code running Opus 4.8 on 2026-07-23. Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
Collaborator
|
Updating this branch to include the changes from #3628 |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Platform docs autocommit