Skip to content

Conversation

@kahowell
Copy link
Member

@kahowell kahowell commented Nov 3, 2025

Description

How Has This Been Tested?

Screenshot or short clip

Merge criteria

  • You have read the contributors guide.
  • Commit messages are meaningful - have a clear and concise summary and detailed explanation of what was changed and why.
  • Pull Request contains a description of the solution, a link to the JIRA issue, and to any dependent or related Pull Request.
  • Testing instructions have been added in the PR body (for PRs involving changes that are not immediately obvious).
  • The developer has manually tested the changes and verified that the changes work
  • The developer has run the integration test pipeline and verified that it passed successfully

E2E test suite update requirement

When bringing new changes to the operator code, such changes are by default required to be accompanied by extending and/or updating the E2E test suite accordingly.

To opt-out of this requirement:

  1. Please inspect the opt-out guidelines, to determine if the nature of the PR changes allows for skipping this requirement
  2. If opt-out is applicable, provide justification in the dedicated E2E update requirement opt-out justification section below
  3. Check the checkbox below:
  • Skip requirement to update E2E test suite for this PR
  1. Submit/save these changes to the PR description. This will automatically trigger the check.

E2E update requirement opt-out justification

docs change

Summary by CodeRabbit

  • Documentation
    • Added guidance to the release workflow clarifying that generated bundles must be regenerated in downstream sync pull requests because the main branch no longer retains most generated files.

@coderabbitai
Copy link

coderabbitai bot commented Nov 3, 2025

Walkthrough

Added a step to the release workflow guide instructing that the release bundle must be regenerated in sync PRs because the main branch no longer keeps most generated files while downstream rhoai branch builds still require bundle contents.

Changes

Cohort / File(s) Summary
Documentation update
docs/release-workflow-guide.md
Added a new step explaining bundle regeneration in sync PRs (references PR #2329) and clarifies branch responsibilities for generated files.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Possible minor copy edits in docs/release-workflow-guide.md (verify spelling/grammar, e.g., "Regenerate").

Poem

🐰 I hopped through branches, neat and sound,
Found bundles hiding, not where they're bound,
In sync PRs I give them light,
So downstream builds run just right,
A tidy hop — the release is found! 📦✨

Pre-merge checks and finishing touches

✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately and concisely describes the main documentation change—adding a note about bundle regeneration being needed for the rhoai branch.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f889796 and f492d22.

📒 Files selected for processing (1)
  • docs/release-workflow-guide.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/release-workflow-guide.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: golangci-lint

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 and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9fd7486 and f889796.

📒 Files selected for processing (1)
  • docs/release-workflow-guide.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/release-workflow-guide.md

[grammar] ~59-~59: Ensure spelling is correct
Context: ...iption to include the ticket link. 3. Renegerate the bundle: As of [#2329](https://git...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: golangci-lint
🔇 Additional comments (1)
docs/release-workflow-guide.md (1)

54-62: Documentation addition looks good.

The new step correctly documents the bundle regeneration requirement in sync PRs, provides clear rationale (referencing #2329 and explaining the downstream dependency), and fits naturally into the upstream workflow sequence.

The PR author should then create another PR targeting the `rhoai` branch. CI automation typically creates the cherry-pick PR. Add a `/cherry-pick rhoai` comment to the original PR; CI will report success or failure. If it fails, manually cherry-pick the commits into a new branch and open a new PR.
3. **Edit the cherry-pick PR:** Edit the title to include the prefix `[sync]`. If the PR is associated with any Jira
ticket, edit the description to include the ticket link.
3. **Renegerate the bundle:** As of [#2329](https://github.com/opendatahub-io/opendatahub-operator/pull/2329), the `main` branch doesn't maintain most generated files anymore; however downstream builds still need bundle contents in the `rhoai` branch, so it is necessary to regenerate the bundle in the sync PR.
Copy link
Member

Choose a reason for hiding this comment

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

should we also mention, if PR touches API config etc should not use "cherrypick" bot instead of create manual PR?

Copy link
Member Author

Choose a reason for hiding this comment

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

It should still be fine in that case, as the API change will cherry-pick cleanly.

It simply won't pass CI checks, specifically, the one in .github/workflows/test-required-files-updated.yaml, so it will require an extra step.

FYI I also have red-hat-data-services#13421 open to remove the need to maintain bundle in the repo in rhoai branch.

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@openshift-ci
Copy link

openshift-ci bot commented Nov 11, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: zdtsw

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@zdtsw zdtsw added documentation Improvements or additions to documentation and removed lgtm approved labels Nov 11, 2025
@zdtsw
Copy link
Member

zdtsw commented Nov 11, 2025

i'd prefer this goes in ODH 3.1 release

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 team-compass

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

2 participants