Skip to content

[ci] Force-update release branch on tagged main commits - #977

Merged
Andrei Kvapil (kvaps) merged 1 commit into
mainfrom
ci-force-push
May 24, 2025
Merged

Andrei Kvapil (kvaps) merged 1 commit into
mainfrom
ci-force-push

Conversation

@kvaps

@kvaps Andrei Kvapil (kvaps) commented May 22, 2025 •

Copy link
Copy Markdown
Member

Signed-off-by: Andrei Kvapil [email protected]

Summary by CodeRabbit

  • Chores
    • Improved the process for updating or creating maintenance branches to ensure they always point to the latest tagged release commit.

@coderabbitai

coderabbitai Bot commented May 22, 2025 •

Copy link
Copy Markdown
Contributor

Walkthrough

The workflow for maintaining the release-X.Y branch in GitHub Actions was updated to explicitly fetch the commit SHA of a tag and use it to either force-update the branch or create it if it does not exist. Console logs were updated to reflect these changes.

Changes

File(s) Change Summary
.github/workflows/pull-requests-release.yaml Enhanced branch maintenance logic to fetch tag commit SHA and force-update or create the branch accordingly. Updated logging for clarity.

Sequence Diagram(s)

sequenceDiagram
    participant Workflow
    participant GitHubAPI

    Workflow->>GitHubAPI: Get commit SHA for tag
    alt Branch exists
        Workflow->>GitHubAPI: Force-update branch to tag's commit SHA
    else Branch does not exist
        Workflow->>GitHubAPI: Create branch at tag's commit SHA
    end
    Workflow->>Workflow: Log actions
Loading

Possibly related PRs

Suggested labels

backport

Suggested reviewers

  • lllamnyp
  • klinch0

Poem

In the warren where workflows hop and run,
A tag’s true SHA is fetched—well done!
Branches now leap to the right commit,
Whether they’re new or just need a refit.
With logs that sparkle and actions neat,
This rabbit’s code is quite the treat! 🐇✨

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 30th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.


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 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.

@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)

110-117: Narrow the catch block to only missing-branch errors
The current try/catch treats every error as “branch not found” and falls back to createRef. To avoid masking other API failures (rate limits, permissions, etc.), restrict the fallback to 404 responses:

 try {
   await github.rest.repos.getBranch({ owner, repo, branch });
   // ...updateRef logic...
 } catch (err) {
-  // Branch doesn't exist, create it
+  if (err.status === 404) {
     await github.rest.git.createRef({ owner, repo, ref: `refs/heads/${branch}`, sha: commitSha });
     console.log(`✅ Created branch '${branch}' at ${commitSha}`);
+  } else {
+    throw err;
+  }
 }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 609e7ed and 2461fcd.

📒 Files selected for processing (1)
  • .github/workflows/pull-requests-release.yaml (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Build and Test
🔇 Additional comments (2)
.github/workflows/pull-requests-release.yaml (2)

92-100: Ensure correct commit SHA for annotated tags
Currently, the workflow fetches the tag ref and uses ref.data.object.sha as the commit SHA. This works for lightweight tags (which your git tag -f creates), but for annotated tags ref.data.object.type will be "tag" and ref.data.object.sha points to the tag object rather than the commit. To make this robust, consider checking ref.data.object.type and, if it equals "tag", invoking github.rest.git.getTag on that tag SHA to dereference to the underlying commit SHA.


90-127: LGTM: maintenance branch now tracks the correct tag commit
The updated step explicitly fetches the tag’s commit SHA and either force-updates or creates the release-X.Y branch at that SHA, fixing the previous mismatch. The console logs are clear and the flow is well-structured.

@kvaps
Andrei Kvapil (kvaps) merged commit 5789f12 into main May 24, 2025
@kvaps
Andrei Kvapil (kvaps) deleted the ci-force-push branch May 24, 2025 20:29
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