Skip to content

docs: add Helm image tag usage to all agent docs#1184

Merged
thepagent merged 2 commits into
mainfrom
docs/helm-image-tag-usage
Jun 24, 2026
Merged

docs: add Helm image tag usage to all agent docs#1184
thepagent merged 2 commits into
mainfrom
docs/helm-image-tag-usage

Conversation

@chaodu-agent

Copy link
Copy Markdown
Collaborator

Summary

Document --set agents.<name>.image.tag=<version>-<agent> in the Helm Install section of all 9 agent platform docs.

Since v0.9.0-beta.2 introduced the unified image architecture, each agent doc now shows how to specify the image tag with examples:

Tag Description
beta-<agent> Floating beta channel
0.9.0-beta.2-<agent> Pinned to exact version
stable-<agent> Floating stable channel

Files changed

  • docs/kiro.md
  • docs/codex.md
  • docs/claude-code.md
  • docs/copilot.md
  • docs/cursor.md
  • docs/gemini.md
  • docs/grok.md
  • docs/hermes.md
  • docs/opencode.md

Each doc now includes:

  1. --set agents.<name>.image.tag=beta-<agent> in the example helm install command
  2. An "Image Tag" subsection with tag format table and link to image-tags.md
  3. Warning that there is no latest tag

Document --set agents.<name>.image.tag=<version>-<agent> in the Helm
Install section of each agent platform doc. Includes examples for beta,
pinned version, and stable channels, with a reference to image-tags.md.
@chaodu-agent chaodu-agent requested a review from thepagent as a code owner June 23, 2026 23:53
@chaodu-agent

This comment has been minimized.

@chaodu-agent

This comment has been minimized.

- Replace invalid --set agents.<name>.image.tag with --set image.tag=beta
- Add per-agent full override example using agents.<name>.image=<full-ref>
- Add missing <major.minor> floating tag format from image-tags.md
- Restore copilot.md inline comment about optional GITHUB_TOKEN

The chart's agents.<name>.image field is a string, not a map.
Setting .image.tag via --set converts it to a map, causing the
template's kindIs "string" check to silently fail.
@chaodu-agent

Copy link
Copy Markdown
Collaborator Author

LGTM ✅ — All findings from Round 1 addressed in cd2be2b.

What This PR Does

Documents Helm image tag usage across all 9 agent platform docs following v0.9.0-beta.2 unified image architecture.

How It Works

Each doc adds: (1) --set image.tag=beta to helm install example (global tag, chart auto-appends -<agent>), (2) "Image Tag" subsection with tag table showing resolved values, (3) per-agent full override example, (4) warning about no latest tag.

Findings

# Severity Finding Location
1 🟢 Correct Helm path: uses global image.tag (chart auto-appends suffix) All 9 docs
2 🟢 Per-agent override documented as agents.<name>.image=<full-ref> All 9 docs
3 🟢 Tag table includes <major.minor> floating format from image-tags.md All 9 docs
4 🟢 copilot.md comment about optional GITHUB_TOKEN restored docs/copilot.md
5 🟢 Consistent structure across all 9 docs
Addressing Round 1 Feedback

🔴 F1: agents.<name>.image.tag path invalid

Fixed in cd2be2b: Replaced with --set image.tag=beta (global). Added per-agent override example using the correct string field: --set agents.<name>.image=ghcr.io/openabdev/openab:<tag>-<agent>.

🟡 F2: Should document global image.tag as primary method

Fixed in cd2be2b: Global --set image.tag= is now the primary documented approach.

🟡 F3: copilot.md comment removed

Fixed in cd2be2b: Restored as a blockquote note below the code block.

🟡 F4: Missing <major.minor>-<agent> tag format

Fixed in cd2be2b: Tag table now includes 0.90.9-<agent> row.

Baseline Check
  • PR opened: 2026-06-23
  • Main already has: docs/image-tags.md with full tag format reference
  • Net-new value: Per-agent docs surface correct image tag guidance inline, using the valid global image.tag path

@thepagent thepagent merged commit d1b0cfb into main Jun 24, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants