ROX-36040: Move fields to release plan

[mtodor]

Description

Move release notes fields (synopsis, topic, description, solution) out of the Release resource template and into the ReleasePlan resource (managed in konflux-release-data). This simplifies the release configuration and release process by eliminating version-specific text substitution for those fields.

Changes:

• Template (scripts/templates/release-resource.yaml): Removed synopsis, topic, description, and solution fields from releaseNotes. Added a GitHub releases tag reference (https://github.com/stackrox/stackrox-mcp/releases/tag/X.Y.Z) for release traceability.
• Script (scripts/prepare-release.sh): Replaced the yq substitution commands for topic and description with a single command that substitutes the version in the new references URL.

Validation

• shellcheck scripts/prepare-release.sh passes clean
• Generated release resources match the format already used on release-0.2

AI-assisted development prompts

This PR was developed with AI assistance. Below are the prompts used:

Prompt: "I want to change template for scripts/templates/release-resource.yaml - and update Script: scripts/prepare-release.sh: we should drop fields: synopsis, topic, description, and solution - this will be part of release plan now. [...] but we should add new reference link: https://github.com/stackrox/stackrox-mcp/releases/tag/X.Y.Z"
Response: Explored the current template, script, and example files (ReleasePlan in konflux-release-data and adjusted resources on release-0.2). After clarifying that both references should be kept and type: RHEA should remain, updated the template to remove the four fields and add the new reference, and updated the script to replace topic/description yq commands with a references substitution command.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository YAML (base), Central YAML (inherited), Organization UI (inherited)

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: 8ad610d4-84ef-4fab-9f01-9e205163fbc8

📥 Commits

Reviewing files that changed from the base of the PR and between bb62e20 and f693207.

📒 Files selected for processing (2)

• scripts/prepare-release.sh
• scripts/templates/release-resource.yaml

Included review availability: Your plan provides up to 12 included reviews per hour; 11 remain after this review.

---

📝 Walkthrough

Summary by CodeRabbit

• Release Notes
  • Release resources now link directly to the corresponding GitHub release.
  • Release version placeholders are automatically replaced with the published version.
  • Removed redundant release-note metadata fields to provide a simpler, more consistent release reference.

Walkthrough

Release resource generation now uses versioned GitHub release references. The release notes template removes synopsis, topic, description, and solution fields.

Changes

Release resource generation

Layer / File(s)	Summary
Versioned release reference generation scripts/templates/release-resource.yaml, scripts/prepare-release.sh	The template adds a GitHub release URL with an X.Y.Z placeholder. The release script replaces the placeholder with the release version instead of updating release-notes topic and description fields.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: ⚪ Minimal · up to f6932

This PR makes a small, localized release-plan field update, and no actionable merge-blocking risk remains beyond normal checks and review.

Suggested reviewers: janisz

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 2 functions across 1 files. (1 skipped: 1 …	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Title check	✅ Passed	The title clearly identifies the main change: moving release-notes fields to the release plan.
Description check	✅ Passed	The description directly explains the template and script changes, including the fields moved and the new GitHub release reference.

Full details: Docstring Coverage

Explanation

Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 2 functions across 1 files. (1 skipped: 1 unsupported.)

• Fix all pre-merge checks with AI

✨ Finishing Touches 💡 1

📝 Generate docstrings 💡

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch mtodor/ROX-36040-move-fields-to-release-plan

---

_{Comment @coderabbitai help to get the list of available commands.}

[codecov-commenter]

❌ 2 Tests Failed:

Tests completed	Failed	Passed	Skipped
380	2	378	12

View the full list of 3 ❄️ flaky test(s)

::policy 1

Flake rate in main: 100.00% (Passed 0 times, Failed 130 times)

Stack Traces | 0s run time

- test violation 1
- test violation 2
- test violation 3

::policy 4

Flake rate in main: 100.00% (Passed 0 times, Failed 130 times)

Stack Traces | 0s run time

- testing multiple alert violation messages 1
- testing multiple alert violation messages 2
- testing multiple alert violation messages 3

github.com/stackrox/stackrox-mcp/smoke::TestSmoke_RealCluster

Flake rate in main: 12.50% (Passed 21 times, Failed 3 times)

Stack Traces | 360s run time

Failed

To view more test analytics, go to the Test Analytics Dashboard
_{📋 Got 3 mins? Take this short survey to help us improve Test Analytics.}

[github-actions]

E2E Test Results

Commit: f693207
Workflow Run: View Details
Artifacts: Download test results & logs

=== Evaluation Summary ===

  ✓ cve-cluster-does-exist (assertions: 3/3)
  ✓ cve-cluster-list (assertions: 3/3)
  ✓ rhsa-not-supported (assertions: 2/2)
  ✓ cve-detected-workloads (assertions: 3/3)
  ✓ cve-nonexistent (assertions: 3/3)
  ✓ cve-log4shell (assertions: 3/3)
  ✓ cve-multiple (assertions: 3/3)
  ✓ cve-cluster-does-not-exist (assertions: 3/3)
  ✓ list-clusters (assertions: 3/3)
  ✓ cve-detected-clusters (assertions: 3/3)
  ✓ cve-clusters-general (assertions: 3/3)

Tasks:      11/11 passed (100.00%)
Assertions: 32/32 passed (100.00%)
Tokens:     ~49589 (estimate - excludes system prompt & cache)
MCP schemas: ~12562 (included in token total)
Agent used tokens:
  Input:  12494 tokens
  Output: 19687 tokens
Judge used tokens:
  Input:  87838 tokens
  Output: 62350 tokens