Update docs for image-syncer/custom-image-builder naming - #3712
Merged
Conversation
Also fixes the Custom Assembly GitOps workflow example, which did not run as written, and standardizes the guide's placeholders. https://linear.app/chainguard/issue/DOCS-96/update-docs-for-apko-builder-custom-image-builder-naming Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Signed-off-by: Mark Drake <mark@chainguard.dev>
✅ Deploy Preview for ornate-narwhal-088216 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Set persist-credentials: false on actions/checkout, since no later step uses git or the GitHub API, and pin crane to v0.21.9 instead of @latest. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Signed-off-by: Mark Drake <mark@chainguard.dev>
Signed-off-by: Mark Drake <mark@chainguard.dev>
Signed-off-by: Mark Drake <mark@chainguard.dev>
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.
[ ] Check if this is a typo or other quick fix and ignore the rest :)
Type of change
Documentation Update / Bug Fix
catalog_syncer/apko_buildertoimage-syncer/custom-image-builderin the Cosign verification and Custom Assembly GitOps guides, noting that older organizations still use the old nameschainctl iam identities createcommand, which used flags that don't existWhat should this PR do?
resolves https://linear.app/chainguard/issue/DOCS-96/update-docs-for-apko-builder-custom-image-builder-naming
Updates both guides to the current signing-identity names and fixes the GitOps guide's workflow example so it runs as written.
Why are we making this change?
Chainguard organizations now provision these identities as
image-syncerandcustom-image-builder, but the docs only referenced the oldercatalog_syncerandapko_buildernames. Testing the GitOps guide end to end against a real GitHub Actions run also surfaced several errors that stopped the example from working:--claim=k=vflags thatchainctldoes not accept, shell variables assigned in onerun:block but referenced in another, and backslash continuations inside single-quotedjqprograms.What are the acceptance criteria?
image-syncerandcustom-image-builder, with the older names given as equivalents rather than removedHow should this PR be tested?
Any documentation published to Chainguard Academy is reviewed carefully for accuracy. GUI procedures, API commands, and CLI code snippets in a draft are run and tested thoroughly — by both the author and the reviewer — to confirm they work exactly as written. This helps ensure that readers can follow along and get the same results. See the
edurepo's README./chainguard/chainguard-images/how-to-use/verifying-chainguard-images-and-metadata-signatures-with-cosign/, confirm the new screenshot renders and thechainctl iam account-associations describesnippets return UIDPs for your organization/chainguard/chainguard-images/features/ca-docs/custom-assembly-gitops/, run the Step 1 identity command, then copy the GitHub Actions example into a test repository and confirm a manually triggered run completes the build🤖 Generated with Claude Code