docs: explain how to find the release ECP - #249
Conversation
Add instructions for looking up the ReleasePlanAdmission name from the ReleasePlan labels, and mention the konflux-release-data repo as an alternative. Follow-up from review feedback on PR conforma#246.
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Team Run ID: Comment |
Use grep releasePlanAdmission for cleaner output, and use <rpa-name> placeholder since we're finding the ReleasePlanAdmission name.
|
🤖 Finished Review · ✅ Success · Started 1:30 PM UTC · Completed 1:43 PM UTC Commit: Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $3.15 |
|
Risk Assessment: low (1/5) DetailsMinimal-risk documentation-only change: a single AsciiDoc file with 22 lines changed, no protected paths, no security-sensitive files, no CI/dependency changes, and a known non-first-time contributor; slightly elevated file churn and fix frequency are explained by an active review cycle on a recently-added guide. |
ReviewFindingsMedium
Next steps:
|
| namespace. To find it, look up your `ReleasePlan` and find the associated | ||
| `ReleasePlanAdmission` name: | ||
|
|
||
| [,shell,subs="+quotes"] |
There was a problem hiding this comment.
[medium] logic-error
Step 1 instructs the user to find the ReleasePlanAdmission (RPA) name and prepend the managed namespace to form a reference like rhtap-releng-tenant/<rpa-name>. However, Step 2's YAML template uses the placeholder <managed-namespace>/<ecp-name>, and the surrounding text says to 'set POLICY_CONFIGURATION to the ECP used by your release pipeline,' referencing an EnterpriseContractPolicy CR. This creates an inconsistency: Step 1 produces an RPA reference, but Step 2 asks for an ECP reference. If POLICY_CONFIGURATION accepts RPA references directly, the Step 2 placeholder and description should be updated to match Step 1's output. If it only accepts ECP references, Step 1 needs an additional command to extract the ECP name from within the RPA.
Suggested fix: Align the two steps. Either (a) update the Step 2 placeholder from <managed-namespace>/<ecp-name> to <managed-namespace>/<rpa-name> and adjust the explanatory text to clarify that POLICY_CONFIGURATION accepts RPA references, or (b) add a command in Step 1 that extracts the ECP reference from the RPA (e.g., oc get releaseplanadmission <rpa-name> -n <managed-namespace> -o yaml | yq .spec.policy).
Follow-up from review on #246.
Adds instructions for finding the release ECP:
oc getFixes: https://redhat.atlassian.net/browse/EC-2007