Skip to content

[EC-1776] docs: Document Cicada content stream update in release process#3433

Open
jsmid1 wants to merge 1 commit into
conforma:mainfrom
jsmid1:EC-1776
Open

[EC-1776] docs: Document Cicada content stream update in release process#3433
jsmid1 wants to merge 1 commit into
conforma:mainfrom
jsmid1:EC-1776

Conversation

@jsmid1

@jsmid1 jsmid1 commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Add a section to the release process docs explaining how to update Pyxis content_stream_tags via Cicada when creating or retiring a release branch.

Ref: https://issues.redhat.com/browse/EC-1776

Add a section to the release process docs explaining how to update
Pyxis content_stream_tags via Cicada when creating or retiring a
release branch.

Ref: https://issues.redhat.com/browse/EC-1776

Co-authored-by: Claude <noreply@anthropic.com>
@fullsend-ai-review

fullsend-ai-review Bot commented Jul 23, 2026

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 8:48 AM UTC · Completed 8:57 AM UTC
Commit: 87c4a29 · View workflow run →

@coderabbitai

coderabbitai Bot commented Jul 23, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 9bca5d82-2987-4fee-8926-4f64d4df23e8

📥 Commits

Reviewing files that changed from the base of the PR and between 4ea11df and 8e50843.

📒 Files selected for processing (1)
  • docs/modules/ROOT/pages/release-process.adoc

📝 Walkthrough

Walkthrough

Changes

Release process documentation

Layer / File(s) Summary
Document Pyxis content stream updates
docs/modules/ROOT/pages/release-process.adoc
Adds Cicada procedures for updating rhtas/ec-rhel9 tags during release branch creation or retirement, submitting changes, and verifying Pyxis fields after merge.

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

Suggested reviewers: simonbaird

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly matches the main change: documenting Cicada content stream updates in the release process.
Description check ✅ Passed The description covers the change and includes a ticket link, but it omits the template's Why section.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@qodo-for-conforma

Copy link
Copy Markdown

PR Summary by Qodo

Docs: Add Cicada/Pyxis content stream update steps to release process

📝 Documentation 🕐 Less than 10 minutes

Grey Divider

AI Description

• Document when to update Pyxis content stream tags during release branch lifecycle.
• Add step-by-step Cicada MR workflow for updating rhtas/ec-rhel9 tags.
• Provide a curl/jq verification command for confirming applied changes in Pyxis.
Diagram

graph TD
  A["Release engineer"] --> B(["Cicada: pyxis-repo-configs"]) --> C["Edit rhtas.yaml tags"] --> D["Open merge request"] --> E(["Cicada dry-run + apply"]) --> F(["Pyxis (stage + prod)"]) --> G["Verify via curl/jq"]
Loading
High-Level Assessment

The following are alternative approaches to this PR:

1. Add a release checklist item (in addition to narrative docs)
  • ➕ Makes the step harder to miss during branch create/retire
  • ➕ Keeps the release process actionable and scannable
  • ➖ Duplicates information unless carefully linked to the detailed section
2. Move Cicada/Pyxis procedure into a dedicated ops page and link from release process
  • ➕ Centralizes Pyxis-tag guidance for reuse by other workflows
  • ➕ Keeps release-process page shorter
  • ➖ Slightly reduces discoverability for release engineers if the link is missed
3. Automate tag updates as part of branch tooling
  • ➕ Reduces manual steps and risk of forgetting updates
  • ➕ Can enforce consistent tag naming/format
  • ➖ Higher implementation/maintenance cost than documentation
  • ➖ Requires access/approval for updating Cicada configs programmatically

Recommendation: Current approach (documenting the procedure directly in the release-process page) is the best near-term option for discoverability and low effort. If this step is frequently missed, consider adding a brief checklist item that links to this section; longer term, automation could reduce operational risk.

Files changed (1) +28 / -0

Documentation (1) +28 / -0
release-process.adocDocument Cicada-driven Pyxis content stream tag updates +28/-0

Document Cicada-driven Pyxis content stream tag updates

• Adds a new section describing when and how to update 'content_stream_tags' and 'auto_rebuild_tags' for 'rhtas/ec-rhel9' via the Cicada 'pyxis-repo-configs' repository. Includes verification instructions using Kerberos-authenticated curl against the Pyxis API.

docs/modules/ROOT/pages/release-process.adoc

@qodo-for-conforma

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Qodo Logo

@fullsend-ai-review

Copy link
Copy Markdown

Looks good to me


Labels: PR adds documentation for the Pyxis/Cicada content stream update process to the release process guide

@fullsend-ai-review fullsend-ai-review Bot added ready-for-merge All reviewers approved — ready to merge documentation Improvements or additions to documentation labels Jul 23, 2026
@codecov

codecov Bot commented Jul 23, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

Flag Coverage Δ
acceptance 54.26% <ø> (ø)
generative 16.80% <ø> (ø)
integration 27.97% <ø> (ø)
unit 71.75% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@simonbaird simonbaird left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation ready-for-merge All reviewers approved — ready to merge size: XS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants