Skip to content

Decouple release of chatbot from OCM/CIM#3079

Merged
openshift-merge-bot[bot] merged 1 commit intoopenshift-assisted:masterfrom
rawagner:decouple_chatbot_release
Jul 28, 2025
Merged

Decouple release of chatbot from OCM/CIM#3079
openshift-merge-bot[bot] merged 1 commit intoopenshift-assisted:masterfrom
rawagner:decouple_chatbot_release

Conversation

@rawagner
Copy link
Copy Markdown
Member

@rawagner rawagner commented Jul 28, 2025

Update release script to handle -chatbot releases.
Chatbot package is included only in -chatbot release, not in OCM or CIM.

Summary by CodeRabbit

  • Chores
    • Updated release workflow to support release tags ending with "-chatbot" in addition to "-cim".
    • Improved log output to clarify when a release is not for the chatbot.
    • Adjusted publishing logic so only the chatbot library is published for "-chatbot" releases; other releases exclude the chatbot library.
  • Documentation
    • Clarified release types and naming conventions for tags with optional suffixes.
    • Updated instructions for drafting releases to include suffix requirements.
    • Expanded list of publicly available artifacts to include the chatbot package.

@openshift-ci openshift-ci bot requested review from batzionb and celdrake July 28, 2025 08:37
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Jul 28, 2025

Walkthrough

The release workflow in .github/workflows/release.yaml was updated to recognize release tags ending with "-chatbot" in addition to "-cim." The script now conditionally publishes only the "chatbot" workspace for "-chatbot" tags, while other tags continue to publish all other public libraries except "chatbot." Corresponding documentation in docs/RELEASE_WORKFLOW.md was updated to reflect these new release types and naming conventions.

Changes

Cohort / File(s) Change Summary
Release Workflow Logic Update
.github/workflows/release.yaml
Expanded tag recognition to include "-chatbot" suffix, added conditional publishing logic for "chatbot" workspace, and updated related logging.
Release Workflow Documentation Update
docs/RELEASE_WORKFLOW.md
Added explanations for three release types (OCM, CIM, Chatbot), updated naming patterns for release branches/tags/titles to include optional suffixes, and expanded artifact list to include @openshift-assisted/chatbot.

Sequence Diagram(s)

sequenceDiagram
    participant GitHub Actions
    participant Release Script

    GitHub Actions->>Release Script: Trigger on release tag/branch
    Release Script->>Release Script: Check if tag ends with "-cim" or "-chatbot"
    alt Tag ends with "-chatbot"
        Release Script->>Release Script: Set LIBS to "chatbot"
    else Tag ends with "-cim"
        Release Script->>Release Script: Set LIBS to all public libs except "chatbot"
    else Not a release tag
        Release Script->>Release Script: Log not a chatbot release
    end
    Release Script->>GitHub Actions: Continue workflow with selected LIBS
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Suggested labels

lgtm, size/XS

Suggested reviewers

  • ElayAharoni
  • ammont82

Poem

A tag with "-chatbot" hops into view,
Now only that workspace gets its due.
The script checks the suffix, decides what to do,
Publishing just what’s needed—no hullabaloo!
Docs updated, workflows refined,
A smoother release, all well-aligned.
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@openshift-ci openshift-ci bot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jul 28, 2025
Copy link
Copy Markdown

@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

🧹 Nitpick comments (1)
.github/workflows/release.yaml (1)

17-21: Nit: update log messages for clarity

The log headings (OCM:, CIM:) pre-date the new chatbot option and can confuse operators.
Consider concise, neutral wording such as “Not a CIM or Chatbot release…”.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 63de569 and 95adc77.

📒 Files selected for processing (1)
  • .github/workflows/release.yaml (2 hunks)

@rawagner rawagner force-pushed the decouple_chatbot_release branch from 95adc77 to af52f01 Compare July 28, 2025 10:02
@openshift-ci openshift-ci bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jul 28, 2025
@rawagner rawagner force-pushed the decouple_chatbot_release branch from af52f01 to 224f9d8 Compare July 28, 2025 10:03
Copy link
Copy Markdown

@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: 0

🧹 Nitpick comments (1)
docs/RELEASE_WORKFLOW.md (1)

31-38: Tweak the branch / tag pattern to avoid a dangling hyphen when no suffix is used.

With the current wording, an “OCM” (no-suffix) release strictly matching
releases/v1.2.3- would contain a trailing dash that does not exist in practice.
A tiny wording adjustment keeps the example accurate:

-`releases/v<some-semver-string>-<optionally_a_suffix>`
+`releases/v<some-semver-string>[ -<suffix> ]`

Repeat the same tweak for the Tag and Title examples below.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 95adc77 and 224f9d8.

📒 Files selected for processing (2)
  • .github/workflows/release.yaml (2 hunks)
  • docs/RELEASE_WORKFLOW.md (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/release.yaml
🧰 Additional context used
🧠 Learnings (1)
docs/RELEASE_WORKFLOW.md (1)

Learnt from: celdrake
PR: #3051
File: libs/chatbot/lib/components/ChatBot/ChatBotWindow.tsx:196-222
Timestamp: 2025-07-18T12:35:50.945Z
Learning: In the assisted-installer-ui chatbot feedback implementation, the onFeedbackSubmit callback requires access to the messages array to retrieve both the bot response content and the associated user question for the API call, making it necessary to include messages in the useCallback dependency array rather than passing message content as props to avoid duplicating potentially long message data.

🪛 LanguageTool
docs/RELEASE_WORKFLOW.md

[grammar] ~29-~29: Ensure spelling is correct
Context: ... 1. Make sure you have been granted the maintaner role in the project settings. 2. Creat...

(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). (2)
  • GitHub Check: tests
  • GitHub Check: lint
🔇 Additional comments (2)
docs/RELEASE_WORKFLOW.md (2)

21-26: Good call-out of the three release “flavors”.

Explicitly listing the OCM, CIM, and Chatbot variants removes guess-work for maintainers and aligns the docs with the new automation.


47-47: Artifact list updated correctly.

Adding @openshift-assisted/chatbot reflects the new publish step—looks good.

Copy link
Copy Markdown
Contributor

@celdrake celdrake left a comment

Choose a reason for hiding this comment

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

Looks good.
We can change the versioning for the Chatbot later if we want.

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jul 28, 2025
@openshift-ci
Copy link
Copy Markdown

openshift-ci bot commented Jul 28, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: celdrake, rawagner

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

The pull request process is described here

Details 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

@openshift-merge-bot openshift-merge-bot bot merged commit a3be475 into openshift-assisted:master Jul 28, 2025
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants