-
Notifications
You must be signed in to change notification settings - Fork 203
docs: note bundle is still needed for rhoai branch #2801
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
docs: note bundle is still needed for rhoai branch #2801
Conversation
WalkthroughAdded 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
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (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)
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. Comment |
There was a problem hiding this 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
📒 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.
docs/release-workflow-guide.md
Outdated
| 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. |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
|
[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 |
|
i'd prefer this goes in ODH 3.1 release |
Description
How Has This Been Tested?
Screenshot or short clip
Merge criteria
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:
E2E update requirement opt-out justificationsection belowE2E update requirement opt-out justification
docs change
Summary by CodeRabbit