chore: try different way to raise PR in raise-rc-pr workflow

[onlyjackfrost]

fix release rc pr workflow

Summary by CodeRabbit

• New Features
  • Improved the automated release process by adding detailed checks for code changes and streamlining pull request creation.
• Chores
  • Updated permissions and refined command handling to prevent workflow disruptions, ensuring reliable operations even when no changes occur.

[coderabbitai]

Walkthrough

The changes update the GitHub Actions workflow by adding new permissions and several steps. The workflow now shows the git status and diff to provide visibility into changes. It commits only if there are modifications and installs the GitHub CLI to create a pull request. A new step is added to verify branch differences before attempting PR creation, and a fallback PR creation step is provided if the new method fails.

Changes

File	Change Summary
.github/.../release-rc-pr.yaml	Added permissions (contents: write, pull-requests: write), new steps to show git status/diff, enhanced commit logic, install GitHub CLI, and create a pull request using the GitHub CLI with a fallback method.

Sequence Diagram(s)

sequenceDiagram
    participant Workflow as GitHub Action Workflow
    participant Git as Git CLI
    participant GHCLI as GitHub CLI
    participant PRSys as Pull Request System

    Workflow ->> Git: Display git status & git diff
    alt Changes detected
        Workflow ->> Git: Commit changes (if any)
        Workflow ->> GHCLI: Install and invoke GitHub CLI for PR creation
        alt PR creation successful
            GHCLI ->> PRSys: Create Pull Request
        else PR creation fails
            Workflow ->> PRSys: Fallback - Create Pull Request using original step
        end
    else No changes detected
        Workflow ->> Workflow: Exit with error message
    end

Loading

Possibly related PRs

• chore: add github action to raise release RC PR #1429: Modifies GitHub Actions workflows for automating the release candidate pull request process, sharing context with these changes.

Suggested reviewers

• wwwy3y3

Poem

I’m a rabbit with hops so keen,
Dancing ‘midst code both bright and green.
Git diff and commits, a neat little fling,
With CLI magic, PR bells ring!
Through branches I nibble, leaving bugs unseen.
Cheers to changes in our workflow scene!

---

📜 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 d9b7c7e and 1129428.

📒 Files selected for processing (1)

• .github/workflows/release-rc-pr.yaml (2 hunks)

🔇 Additional comments (7)

.github/workflows/release-rc-pr.yaml (7)

19-22: Permissions Configuration Updated
The new permissions (contents: write and pull-requests: write) are correctly granted to enable committing changes and creating pull requests. Make sure these permissions are well-documented and reviewed periodically to adhere to the principle of least privilege.

---

65-72: Git Command Visibility Enhancements
The added steps to show git status and git diff significantly improve transparency by displaying repository changes prior to further processing. This aids in debugging and ensures the workflow behaves as expected.

---

76-77: Robust Commit Handling
The commit command now correctly handles the scenario when no changes are staged by using the || echo "No changes to commit" fallback. This prevents the workflow from failing unnecessarily due to a non-zero exit code.

---

82-83: Enhanced Branch Push Logging
The additional echo after the push confirms that the branch was successfully pushed, which is useful for both debugging and logging purposes.

---

84-92: Automated GitHub CLI Installation
The step for installing the GitHub CLI (gh) is implemented thoroughly, including dependency checks for curl and proper keyring setup. Although the chained commands are acceptable here, consider adding error handling or logging in case the installation fails unexpectedly.

---

93-109: PR Creation with GitHub CLI
The new approach to create a pull request uses a pre-check (via git diff --quiet) to ensure that there are actual changes before attempting a PR creation. This is a robust way to avoid creating empty or redundant PRs. Verify that the comparison against origin/main works as intended in your environment.

---

110-120: Fallback PR Creation Mechanism
The fallback step using the peter-evans/create-pull-request@v5 action is a well-thought-out safety net to cover cases where the GitHub CLI method fails. This ensures that the workflow consistently attempts to create a pull request, thereby increasing overall reliability.

🧰 Tools

🪛 actionlint (1.7.4)

112-112: the runner of "peter-evans/create-pull-request@v5" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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