Add AGENTS.md guidance that metadata version/OCI tag mismatches block /publish
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 78/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- github-actions, yaml
- Domain
- ci-cd, documentation
Research direction
Read the Working with Workspaces section of AGENTS.md and the metadata examples under workspaces//metadata/.yaml. Review PR #2896 and the linked /publish validation run to understand the documented mismatch cases. Done means AGENTS.md clearly identifies version, OCI tag, and Backstage compatibility mismatches as blocking and requires checking every package in plugins-list.yaml.
Written by the indexing model from the issue text.
Description
What happened
On PR #2896, the initial commit updated source.json and the main theme metadata but did not update the qe-theme metadata file. The review agent (run 30066160356) correctly identified this: it noted that qe-theme metadata still referenced version 0.11.0 while the upstream source had bumped to 0.12.0. However, it classified this as a low-severity finding. When the author ran /publish, the publish workflow failed with 3 metadata validation errors — the version mismatch and OCI tag mismatches were hard errors. This required a second commit and another publish cycle, adding ~20 minutes of delay and wasted CI resources.
What could go better
The review agent had the right finding but the wrong severity. The AGENTS.md does not currently document that /publish includes a metadata validation step that enforces strict consistency between the built plugin versions and the metadata YAML fields (spec.version, spec.dynamicArtifact OCI tag). Because the review agent didn't know this validation was a hard gate, it reasonably classified the inconsistency as informational rather than blocking. Adding this context to AGENTS.md would let the review agent correctly flag metadata mismatches as blocking findings that will fail the publish pipeline. Confidence is high: this is a factual gap in the documented review criteria, and the /publish metadata validation is a deterministic check.
Proposed change
Add to the 'Working with Workspaces' section of AGENTS.md, after the existing metadata YAML documentation, a subsection titled 'Metadata Validation in /publish'. The guidance should state:
- The
/publishworkflow includes a metadata validation step that compares each built plugin's actual version and Backstage compatibility version against the correspondingspec.version,spec.dynamicArtifactOCI tag, andspec.backstage.supportedVersionsfields inworkspaces/*/metadata/*.yaml. - Any mismatch between these fields and the actual build output causes
/publishto fail. This is a hard gate, not a warning. - When reviewing workspace update PRs, the review agent should verify that ALL metadata YAML files in the workspace are updated consistently with the new
source.jsonref. If any metadata file still references old versions or OCI tags, this should be flagged as a blocking finding because it will cause/publishto fail. - In particular, check that every package listed in
plugins-list.yamlhas its corresponding metadata YAML updated when the workspace'ssource.jsonchanges.
Validation criteria
On the next workspace update PR where a metadata YAML file is not updated consistently with source.json, the review agent should flag it as a blocking finding (not low-severity). Verify on at least 3 workspace update PRs that the review agent explicitly checks all metadata YAML files for version/OCI tag consistency.
Generated by retro agent from https://github.com/redhat-developer/rhdh-plugin-export-overlays/pull/2896
- Dominant language
- TypeScript
- Stars
- 9
- Forks
- 72
- Avg merge
- 3d 9h
- Merged PRs (30d)
- 133
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from redhat-developer/rhdh-plugin-export-overlays
-
documentation non-workspace-changes ready-for-triage ready-to-code
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
redhat-developer/rhdh-plugin-export-overlays#3815 · 3 comments ·
-
documentation non-workspace-changes ready-for-triage ready-to-code
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
redhat-developer/rhdh-plugin-export-overlays#3810 · 3 comments ·
-
Add AGENTS.md review guidance: Prettier/ESLint/TypeScript violations in e2e-tests are CI-blocking Opendocumentation ready-for-triage ready-to-code
Difficulty 1/5 Under an hour Newbie friendliness 88/100
redhat-developer/rhdh-plugin-export-overlays#3792 · 3 comments ·
-
e2e-failure ready-to-code
Difficulty 1/5 Under an hour Newbie friendliness 88/100
redhat-developer/rhdh-plugin-export-overlays#3789 · 1 comment ·
-
e2e-failure ready-to-code
Difficulty 1/5 Under an hour Newbie friendliness 88/100
redhat-developer/rhdh-plugin-export-overlays#3788 · 1 comment ·
All issues in redhat-developer/rhdh-plugin-export-overlays
Similar issues
-
calcite-components needs triage refactor
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Esri/calcite-design-system#15203 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 91/100
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
Difficulty 1/5 Under an hour Newbie friendliness 95/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Automattic/studio#4908 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100