docs(schema): document infrahubctl schema format (blocked on SDK release) - #10088
Open
petercrocker wants to merge 1 commit into
Open
docs(schema): document infrahubctl schema format (blocked on SDK release)#10088petercrocker wants to merge 1 commit into
infrahubctl schema format (blocked on SDK release)#10088petercrocker wants to merge 1 commit into
Conversation
Add a "Format schema files" section to the Create and load schema page: default key-ordering behaviour, --diff / --check, and the opt-in --strip-defaults / --sort-by-order-weight / --backfill-order-weight flags. DO NOT MERGE until an infrahub-sdk release that ships `infrahubctl schema format` is published (feature merged in opsmill/infrahub-sdk-python#1189). Merging earlier would document a command absent from the released CLI.
github-actions
Bot
added
the
type/documentation
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
No issues found across 1 file
Confidence score: 5/5
- Automated review surfaced no issues in the provided summaries.
- No files require special attention.
Shadow auto-approve: would auto-approve. This PR adds only documentation for a future CLI command. No code, behavior, or operational changes. The change is bounded and clearly beneficial.
Re-trigger cubic
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
1 participant
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.
What
Adds a Format schema files section to
docs/docs/schema/create-and-load.mdx, documenting the newinfrahubctl schema formatcommand as a sibling of the existingschema check/schema loadoperations.Where and why
schema formatis a schema operation (something you do to your schema files), so the narrative belongs in Schema & Data → Schema operations, on the page that already covers check/load. The section sits before "Check a schema" to match the real workflow order (write → format → check → load). The per-flag reference stays canonical in the auto-generatedinfrahubctl-schemapage; this page links out to it rather than duplicating the option table.Contents
--diff(preview) and--check(exit non-zero if any file would change; suitable for pre-commit / CI).--strip-defaults,--sort-by-order-weight(cross-linked to the Order weight page),--backfill-order-weight.infrahubctl schemareference via the standard$(base_url)convention.Checks
Vale, markdownlint, and link targets all pass.