Skip to content

docs(#3487): add review guidance for Plugin YAML installation OCI tags #3488

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fullsend-ai-coder wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(#3487): add review guidance for Plugin YAML installation OCI tags #3488

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,16 @@ Key fields: `spec.categories`, `spec.highlights`, `spec.icon` (base64 SVG), `spe

After creating/editing, add the file to `plugins/all.yaml`.

#### Installation Example Version Tags

Plugin YAML files may include a `spec.installation` section with OCI image references (e.g., `oci://ghcr.io/.../plugin-name:bs_1.54.4__0.5.0`). The version tags in these examples must match the corresponding Package metadata `spec.dynamicArtifact` fields in `workspaces/*/metadata/*.yaml`.

**Review criteria:**

1. **Cross-check OCI tags against Package metadata.** For every OCI reference in `spec.installation`, find the corresponding Package metadata YAML and compare the tag. The tag format is `bs_<backstage-version>__<plugin-version>`. Both the Backstage version and the plugin version must match. Flag mismatches as medium severity — stale tags cause users to install outdated or non-existent plugin versions.
2. **Watch for rebase-induced staleness.** Rebasing a Plugin YAML PR after a workspace version bump (via `update-plugins-repo-refs.yaml` or manual update) can silently introduce stale OCI tags. The original commit may have been correct at the time, but the rebase picks up updated Package metadata while the Plugin YAML installation examples remain unchanged. This is a common source of mismatches — check for it explicitly when a PR has been rebased.
3. **Recommended fix:** Update the OCI tags in `spec.installation` to match the current Package metadata `spec.dynamicArtifact` values. To find the current tag, read the corresponding `workspaces/*/metadata/*.yaml` file and copy the tag from `spec.dynamicArtifact`.

### Package YAML (`workspaces/*/metadata/*.yaml`)

Uses `kind: Package`. Key fields: `spec.packageName`, `spec.dynamicArtifact` (OCI reference), `spec.version`, `spec.backstage.role` (frontend-plugin/backend-plugin), `spec.support` (community/production/tech-preview), `spec.appConfigExamples`.
Expand Down
Loading