Skip to content

Update docs for image-syncer/custom-image-builder naming - #3712

Merged
SharpRake merged 4 commits into
chainguard-dev:mainfrom
SharpRake:srvc-accts
Aug 6, 2026
Merged

Update docs for image-syncer/custom-image-builder naming#3712
SharpRake merged 4 commits into
chainguard-dev:mainfrom
SharpRake:srvc-accts

Conversation

@SharpRake

Copy link
Copy Markdown
Collaborator

[ ] Check if this is a typo or other quick fix and ignore the rest :)

Type of change

Documentation Update / Bug Fix

  • Renames catalog_syncer/apko_builder to image-syncer/custom-image-builder in the Cosign verification and Custom Assembly GitOps guides, noting that older organizations still use the old names
  • Fixes the GitOps guide's GitHub Actions example, which failed at several steps as written
  • Corrects the Step 1 chainctl iam identities create command, which used flags that don't exist
  • Standardizes the GitOps guide's placeholders and replaces the identity screenshot

What 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-syncer and custom-image-builder, but the docs only referenced the older catalog_syncer and apko_builder names. 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=v flags that chainctl does not accept, shell variables assigned in one run: block but referenced in another, and backslash continuations inside single-quoted jq programs.

What are the acceptance criteria?

  • Both guides use image-syncer and custom-image-builder, with the older names given as equivalents rather than removed
  • The Step 1 identity command creates an identity a GitHub Actions workflow can actually assume, including on manual runs
  • The GitHub Actions example completes a Custom Assembly build when copied and filled in
  • Placeholders are consistent within the GitOps guide, and distinguish the GitHub repository from the Chainguard image repository

How 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 edu repo's README.

  1. Check the preview link and ensure the changes look right
  2. On /chainguard/chainguard-images/how-to-use/verifying-chainguard-images-and-metadata-signatures-with-cosign/, confirm the new screenshot renders and the chainctl iam account-associations describe snippets return UIDPs for your organization
  3. On /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

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>
@SharpRake
SharpRake requested a review from a team as a code owner August 5, 2026 22:37
@netlify

netlify Bot commented Aug 5, 2026

Copy link
Copy Markdown

Deploy Preview for ornate-narwhal-088216 ready!

Name Link
🔨 Latest commit 2de89bc
🔍 Latest deploy log https://app.netlify.com/projects/ornate-narwhal-088216/deploys/6a749cc09751ab0008911ada
😎 Deploy Preview https://deploy-preview-3712--ornate-narwhal-088216.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

SharpRake and others added 2 commits August 5, 2026 15:45
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>

@matthewhelmke matthewhelmke left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thank you!

Signed-off-by: Mark Drake <mark@chainguard.dev>
@SharpRake
SharpRake merged commit d9ebe5a into chainguard-dev:main Aug 6, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants