Repository navigation
style(antora.yml): satisfy the yamlfmt pre-commit hook - #257
Merged
Merged
Conversation
The pre-commit workflow has been failing on main since 121444f: yamlfmt reformats antora.yml, so the hook reports modified files and exits non-zero. Every PR opened against main inherits the red check. Apply what the hook produces: add the document start marker and write the null version as an empty value. Both forms parse to null, so the component stays versionless and Antora's behaviour is unchanged. `pre-commit run --all-files` now passes with no files modified. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Signed-off-by: Bill Traynor <wmat@riscv.org>
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
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.
Problem
The
pre-commitworkflow has been failing onmainsince121444f(merge of #253). Theyamlfmthook reformatsantora.yml, so the hook reports modified files and the job exits non-zero. The last green run onmainwas2aef34eon 2026-07-31.Because the check runs against the merge with
main, every PR opened since then inherits the red check regardless of what it touches — e.g. #256, which does not go near a YAML file the hook rewrites.Fix
Apply exactly what the hook produces:
Both
~and an empty value parse to YAML null, so the component stays versionless and Antora's behaviour is unchanged (yaml.safe_load→{'name': 'common', 'title': 'Common Assets', 'version': None}before and after).Verification
pre-commit run --all-filespasses locally with no files modified:🤖 Generated with Claude Code