Skip to content

[ci] Fix release branch matching - #800

Merged
Andrei Kvapil (kvaps) merged 1 commit into
mainfrom
release-branch-matching
Apr 11, 2025
Merged

[ci] Fix release branch matching#800
Andrei Kvapil (kvaps) merged 1 commit into
mainfrom
release-branch-matching

Conversation

@kvaps

@kvaps Andrei Kvapil (kvaps) commented Apr 11, 2025

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Chores
    • Updated the branch naming convention for release management to remove the 'v' prefix.
    • Revised the displayed error messages to match the new format.

@coderabbitai

coderabbitai Bot commented Apr 11, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

This pull request updates the GitHub Actions workflow for release management by modifying the regular expression pattern used to validate branch names. The change removes the 'v' prefix from the expected branch naming convention, switching from release-vX.Y.Z[-suffix] to release-X.Y.Z[-suffix]. Additionally, the error message has been updated to reflect this new format. The overall extraction logic for determining the version tag remains unchanged, ensuring that only the branch name validation criteria and associated messaging are adjusted.

Changes

File Path Change Summary
.github/workflows/pull-requests-release.yaml Modified regex pattern and error message to remove the 'v' prefix from branch names.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant GitHubActions as GitHub Actions Workflow
    Developer->>GitHubActions: Push branch (e.g., release-1.2.3-suffix)
    GitHubActions->>GitHubActions: Validate branch name using regex (no 'v' prefix)
    alt Branch name matches expected format
        GitHubActions->>Developer: Proceed with release management steps
    else Branch name invalid
        GitHubActions->>Developer: Return error message (expected format: release-X.Y.Z[-suffix])
    end
Loading

Poem

I hopped through lines of code today,
Regex changed and led the way.
No more "v" to cloud the view,
Branches gleam with a format new.
With every hop, a bug erased,
A rabbit's cheer for a workflow graced!
🐇🌟

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

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)
.github/workflows/pull-requests-release.yaml (1)

55-55: Remove Trailing Whitespace

YAMLlint flagged trailing spaces on this line. Removing these extraneous spaces will help maintain clean formatting and avoid linting warnings.

🧰 Tools
🪛 YAMLlint (1.35.1)

[error] 55-55: trailing spaces

(trailing-spaces)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between fd24070 and 12bedef.

📒 Files selected for processing (1)
  • .github/workflows/pull-requests-release.yaml (1 hunks)
🧰 Additional context used
🪛 YAMLlint (1.35.1)
.github/workflows/pull-requests-release.yaml

[error] 55-55: trailing spaces

(trailing-spaces)

🔇 Additional comments (2)
.github/workflows/pull-requests-release.yaml (2)

54-54: Branch Matching Regex Updated

The regex now correctly removes the 'v' prefix, enforcing the branch naming format as release-X.Y.Z[-suffix]. This aligns with the PR objective and should correctly validate release branches.


57-57: Error Message Reflects New Naming Convention

The error message was updated to match the new format by removing the 'v' prefix. This ensures that users are notified of the expected branch format as release-X.Y.Z[-suffix] if validation fails.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant