Repository navigation
docs(tailor): complete shipped CLI and workflow coverage - #850
Draft
Paco Huelsz (frhuelsz) wants to merge 6 commits into
Draft
Paco Huelsz (frhuelsz) wants to merge 6 commits into
Paco Huelsz (frhuelsz) wants to merge 6 commits into
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
Azure Pipelines: 1 pipeline(s) were filtered out due to trigger conditions. There may be pipelines that require an authorized user to comment /azp run to run. |
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
Workflow instructions still permit unsafe overlapping builds and contain verified selection and dependency-scheduling inaccuracies.
4 open findings
What changed in this PR
Updates Tailor documentation to reflect shipped CLI behavior and expand practical workflow guidance. No application code changes.
Changes:
- Replaces lockfile guarantees with per-run resolution guidance.
- Corrects CLI, YAML, runtime, and cleanup documentation.
- Adds guides for dependencies, CI matrices, logging, artifacts, and rebuilding.
| File | Description |
|---|---|
| tools/tailor/README.md | Updates feature and build summaries. |
| tools/tailor/docs/tutorials/your-first-matrix.md | Corrects explain output. |
| tools/tailor/docs/tutorials/getting-started.md | Completes scaffold and build instructions. |
| tools/tailor/docs/reference/tailor-yaml.md | Clarifies runtime and toolchain settings. |
| tools/tailor/docs/reference/output-formats.md | Clarifies artifact naming. |
| tools/tailor/docs/reference/image-yaml.md | Expands image schema guidance. |
| tools/tailor/docs/reference/directives.md | Documents field-specific merging. |
| tools/tailor/docs/reference/cli.md | Corrects shipped command behavior. |
| tools/tailor/docs/how-to/use-a-local-ic-image.md | Clarifies local-image resolution. |
| tools/tailor/docs/how-to/track-build-inputs.md | Adds incremental-input guidance. |
| tools/tailor/docs/how-to/skip-experimental-cells.md | Adds selective-skipping recipe. |
| tools/tailor/docs/how-to/sign-an-image.md | Clarifies signing prerequisites. |
| tools/tailor/docs/how-to/set-the-build-directory.md | Expands scratch safety guidance. |
| tools/tailor/docs/how-to/README.md | Indexes new guides. |
| tools/tailor/docs/how-to/pin-the-ic-version.md | Reframes toolchain tag selection. |
| tools/tailor/docs/how-to/override-a-base-per-axis.md | Adds OCI preview opt-in. |
| tools/tailor/docs/how-to/manage-extracted-artifacts.md | Explains extraction policies. |
| tools/tailor/docs/how-to/generate-a-ci-matrix.md | Adds CI matrix guidance. |
| tools/tailor/docs/how-to/export-configs-for-a-pipeline.md | Clarifies pipeline responsibilities. |
| tools/tailor/docs/how-to/cross-arch-building.md | Adds OCI preview opt-in. |
| tools/tailor/docs/how-to/convert-an-image-format.md | Corrects conversion scratch behavior. |
| tools/tailor/docs/how-to/clean-and-rebuild.md | Documents cleanup and build locking. |
| tools/tailor/docs/how-to/capture-build-logs.md | Adds logging configuration guidance. |
| tools/tailor/docs/how-to/build-with-an-azure-linux-base.md | Clarifies per-run digest resolution. |
| tools/tailor/docs/how-to/build-dependent-images.md | Adds producer-consumer recipes. |
| tools/tailor/docs/explanation/threat-model.md | Revises registry identity guarantees. |
| tools/tailor/docs/explanation/merge-model.md | Clarifies predicates and precedence. |
| tools/tailor/docs/explanation/design-rationale.md | Updates resolution terminology. |
| tools/tailor/docs/explanation/crate-architecture.md | Updates core responsibilities. |
| tools/tailor/docs/explanation/base-images.md | Clarifies sources and hash caching. |
| tools/tailor/COMPATIBILITY.md | Removes lockfile-format guidance. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+60
to
+61
| builds its producer first. Use `dependsOn: [base-os]` only when you need build ordering **without** | ||
| consuming its bytes; order-only edges do not change the consumer's fingerprint. |
| if a remaining stamp says the cell is current. | ||
|
|
||
| A real `build` acquires an advisory lock at `<output-dir>/.tailor/build.lock`. A second build | ||
| targeting that output directory fails promptly; use a distinct `--output-dir` for parallel runs. |
| ``` | ||
|
|
||
| JSON cells contain `image`, `slug`, `axes`, `format`, and (for a catalogue-backed cell) | ||
| `baseImage`. A slug can be fed to `tailor build <slug>` or `tailor build --cell <slug>`. |
| `tailor build` and `tailor matrix` omit it, but `tailor build experimental --dry-run` selects | ||
| it explicitly. `tailor list` marks the image `(skip)`. | ||
|
|
||
| To skip just one matrix value, set `skip` in its fragment: |
This branch has not been deployed
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.
Summary
Validation
git diff --checkpasses.