ci: auto revert PRs when they break main #17061
Conversation
WalkthroughA new GitHub Actions workflow named Changes
Possibly related PRs
Suggested labels
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Outside diff range and nitpick comments (2)
scripts/ci/revert-pr.sh (1)
1-22: Consider architectural improvements for better maintainabilityTo improve the script's maintainability and integration with the workspace:
Move configuration to environment variables or a config file:
- GitHub repository name
- Revert PR title format
- Error messages
Add logging levels and structured output:
- Use a logging function for consistent output
- Support different verbosity levels
- Consider JSON output format for better parsing
Integration with workspace:
- Consider using workspace-level utilities for consistent behavior
- Add documentation about script usage in CI context
Would you like me to provide an example implementation of these improvements?
.github/workflows/revert-pr.yaml (1)
3-14: Consider optimizing workflow triggersThe current trigger configuration might cause redundant workflow executions due to overlapping events. Consider:
- Using only
workflow_runevent to catch all failures- Specifying critical workflows instead of '*' to reduce unnecessary executions
on: - pull_request: - types: [closed] - branches: - - main - check_suite: - types: [completed] workflow_run: - workflows: ['*'] + workflows: ['CI', 'Tests'] # specify your critical workflows types: [completed] branches: - main
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (2)
.github/workflows/revert-pr.yaml(1 hunks)scripts/ci/revert-pr.sh(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
scripts/ci/revert-pr.sh (1)
Pattern scripts/**/*: "Confirm that the code adheres to the following:
- Script efficiency, readability, and maintainability.
- Usage of environmental variables and configuration files for flexibility.
- Integration with NX workspace utilities and commands."
🪛 actionlint (1.7.4)
.github/workflows/revert-pr.yaml
22-22: label "ec2-runners" is unknown. available labels are "windows-latest", "windows-latest-8-cores", "windows-2022", "windows-2019", "ubuntu-latest", "ubuntu-latest-4-cores", "ubuntu-latest-8-cores", "ubuntu-latest-16-cores", "ubuntu-24.04", "ubuntu-22.04", "ubuntu-20.04", "macos-latest", "macos-latest-xl", "macos-latest-xlarge", "macos-latest-large", "macos-15-xlarge", "macos-15-large", "macos-15", "macos-14-xl", "macos-14-xlarge", "macos-14-large", "macos-14", "macos-13-xl", "macos-13-xlarge", "macos-13-large", "macos-13", "macos-12-xl", "macos-12-xlarge", "macos-12-large", "macos-12", "self-hosted", "x64", "arm", "arm64", "linux", "macos", "windows". if it is a custom label for self-hosted runner, set list of labels in actionlint.yaml config file
(runner-label)
30-30: shellcheck reported issue in this script: SC2086:info:2:12: Double quote to prevent globbing and word splitting
(shellcheck)
🔇 Additional comments (2)
.github/workflows/revert-pr.yaml (2)
31-31: Verify the revert-pr.sh script implementation
The workflow depends on ./scripts/ci/revert-pr.sh which needs to be reviewed for proper error handling and GitHub API interaction.
✅ Verification successful
Script has proper error handling and GitHub API interaction
The revert-pr.sh script implementation is well-structured and includes:
- Proper usage of GitHub CLI (
gh) for API interactions - Error handling through command substitution (
read -r) - GraphQL mutation with proper parameter handling
- Returns the new PR number for workflow continuation
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check if the revert script exists and review its implementation
if [[ -f "./scripts/ci/revert-pr.sh" ]]; then
cat "./scripts/ci/revert-pr.sh"
else
echo "Warning: revert-pr.sh script not found"
# Search for the script in case the path is different
fd "revert-pr.sh"
fi
Length of output: 608
22-23: Verify custom runner configuration and enhance conditions
- The
ec2-runnerslabel needs to be properly configured in your self-hosted runners setup - The condition might miss edge cases where the PR is merged but the failure is from a different workflow
Consider enhancing the conditions:
- if: github.event.pull_request.merged == true && github.event.workflow_run.conclusion == 'failure'
+ if: |
+ github.event.workflow_run.conclusion == 'failure' &&
+ github.event.workflow_run.head_branch == 'main' &&
+ contains(github.event.workflow_run.head_commit.message, 'Merge pull request')🧰 Tools
🪛 actionlint (1.7.4)
22-22: label "ec2-runners" is unknown. available labels are "windows-latest", "windows-latest-8-cores", "windows-2022", "windows-2019", "ubuntu-latest", "ubuntu-latest-4-cores", "ubuntu-latest-8-cores", "ubuntu-latest-16-cores", "ubuntu-24.04", "ubuntu-22.04", "ubuntu-20.04", "macos-latest", "macos-latest-xl", "macos-latest-xlarge", "macos-latest-large", "macos-15-xlarge", "macos-15-large", "macos-15", "macos-14-xl", "macos-14-xlarge", "macos-14-large", "macos-14", "macos-13-xl", "macos-13-xlarge", "macos-13-large", "macos-13", "macos-12-xl", "macos-12-xlarge", "macos-12-large", "macos-12", "self-hosted", "x64", "arm", "arm64", "linux", "macos", "windows". if it is a custom label for self-hosted runner, set list of labels in actionlint.yaml config file
(runner-label)
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #17061 +/- ##
=======================================
Coverage 35.69% 35.69%
=======================================
Files 6938 6938
Lines 147122 147122
Branches 41824 41824
=======================================
Hits 52516 52516
Misses 94606 94606
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report in Codecov by Sentry.
|
Datadog ReportBranch report: ✅ 0 Failed, 84 Passed, 0 Skipped, 31.36s Total Time |
…s into ci/revert-pr-workflow
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (4)
.github/workflows/revert-pr.yaml (4)
1-1: Fix typo in workflow nameThe workflow name "Checksuit" appears to be a typo. Consider changing it to "Checksuite" for better clarity and consistency.
-name: Checksuit +name: Checksuite
43-50: Enhance PR fetching error handlingThe PR fetching logic could be improved with better error handling and logging.
- COMMIT_SHA="${{ github.event.workflow_run.head_commit.id }}" - PR_NUMBER=$(bash ./scripts/ci/get-pr.sh "$COMMIT_SHA") - - if [ -n "$PR_NUMBER" ]; then - echo "PR_NUMBER=$PR_NUMBER" >> $GITHUB_OUTPUT - else - echo "No merged PR found for commit $COMMIT_SHA." - fi + COMMIT_SHA="${{ github.event.workflow_run.head_commit.id }}" + if [ -z "$COMMIT_SHA" ]; then + echo "Error: Commit SHA is empty" + exit 1 + fi + + if ! PR_NUMBER=$(bash ./scripts/ci/get-pr.sh "$COMMIT_SHA"); then + echo "Error: Failed to fetch PR number for commit $COMMIT_SHA" + exit 1 + fi + + if [ -n "$PR_NUMBER" ]; then + echo "Found PR #$PR_NUMBER for commit $COMMIT_SHA" + echo "PR_NUMBER=$PR_NUMBER" >> $GITHUB_OUTPUT + else + echo "No merged PR found for commit $COMMIT_SHA" + fi
86-86: Improve condition readabilityThe condition is complex and could be split for better readability.
- if: ${{ github.event_name == 'pull_request' && contains(github.event.pull_request.labels.*.name, 'revert') && (github.event.pull_request.merged == true || github.event.pull_request.draft == true) && github.actor != 'github-actions' }} + if: | + ${{ + github.event_name == 'pull_request' && + contains(github.event.pull_request.labels.*.name, 'revert') && + (github.event.pull_request.merged == true || github.event.pull_request.draft == true) && + github.actor != 'github-actions' + }}
1-98: Consider enhancing the revert workflowThe workflow architecture could benefit from these improvements:
- Add notifications to PR authors when their PRs are reverted
- Implement a cooldown period before reverting to allow for quick fixes
- Add detailed logging of revert reasons in PR comments
Would you like assistance in implementing any of these suggestions?
🧰 Tools
🪛 actionlint (1.7.4)
28-28: label "ec2-runners" is unknown. available labels are "windows-latest", "windows-latest-8-cores", "windows-2022", "windows-2019", "ubuntu-latest", "ubuntu-latest-4-cores", "ubuntu-latest-8-cores", "ubuntu-latest-16-cores", "ubuntu-24.04", "ubuntu-22.04", "ubuntu-20.04", "macos-latest", "macos-latest-xl", "macos-latest-xlarge", "macos-latest-large", "macos-15-xlarge", "macos-15-large", "macos-15", "macos-14-xl", "macos-14-xlarge", "macos-14-large", "macos-14", "macos-13-xl", "macos-13-xlarge", "macos-13-large", "macos-13", "macos-12-xl", "macos-12-xlarge", "macos-12-large", "macos-12", "self-hosted", "x64", "arm", "arm64", "linux", "macos", "windows". if it is a custom label for self-hosted runner, set list of labels in actionlint.yaml config file
(runner-label)
42-42: shellcheck reported issue in this script: SC2086:info:5:34: Double quote to prevent globbing and word splitting
(shellcheck)
70-70: property "fetch-pr" is not defined in object type {detect-failure: {outputs: {pr_number: string}; result: string}}
(expression)
74-74: property "fetch-pr" is not defined in object type {detect-failure: {outputs: {pr_number: string}; result: string}}
(expression)
80-80: shellcheck reported issue in this script: SC2086:info:2:12: Double quote to prevent globbing and word splitting
(shellcheck)
96-96: shellcheck reported issue in this script: SC2086:info:2:12: Double quote to prevent globbing and word splitting
(shellcheck)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
.github/workflows/revert-pr.yaml(1 hunks)
🧰 Additional context used
🪛 actionlint (1.7.4)
.github/workflows/revert-pr.yaml
28-28: label "ec2-runners" is unknown. available labels are "windows-latest", "windows-latest-8-cores", "windows-2022", "windows-2019", "ubuntu-latest", "ubuntu-latest-4-cores", "ubuntu-latest-8-cores", "ubuntu-latest-16-cores", "ubuntu-24.04", "ubuntu-22.04", "ubuntu-20.04", "macos-latest", "macos-latest-xl", "macos-latest-xlarge", "macos-latest-large", "macos-15-xlarge", "macos-15-large", "macos-15", "macos-14-xl", "macos-14-xlarge", "macos-14-large", "macos-14", "macos-13-xl", "macos-13-xlarge", "macos-13-large", "macos-13", "macos-12-xl", "macos-12-xlarge", "macos-12-large", "macos-12", "self-hosted", "x64", "arm", "arm64", "linux", "macos", "windows". if it is a custom label for self-hosted runner, set list of labels in actionlint.yaml config file
(runner-label)
42-42: shellcheck reported issue in this script: SC2086:info:5:34: Double quote to prevent globbing and word splitting
(shellcheck)
70-70: property "fetch-pr" is not defined in object type {detect-failure: {outputs: {pr_number: string}; result: string}}
(expression)
74-74: property "fetch-pr" is not defined in object type {detect-failure: {outputs: {pr_number: string}; result: string}}
(expression)
80-80: shellcheck reported issue in this script: SC2086:info:2:12: Double quote to prevent globbing and word splitting
(shellcheck)
96-96: shellcheck reported issue in this script: SC2086:info:2:12: Double quote to prevent globbing and word splitting
(shellcheck)
🔇 Additional comments (4)
.github/workflows/revert-pr.yaml (4)
70-70:
Fix incorrect job reference
The condition references needs.fetch-pr but the job is named detect-failure.
- if: ${{ needs.fetch-pr.outputs.PR_NUMBER && github.event.workflow_run.conclusion == 'failure' }}
+ if: ${{ needs.detect-failure.outputs.PR_NUMBER && github.event.workflow_run.conclusion == 'failure' }}Likely invalid or redundant comment.
🧰 Tools
🪛 actionlint (1.7.4)
70-70: property "fetch-pr" is not defined in object type {detect-failure: {outputs: {pr_number: string}; result: string}}
(expression)
97-98:
Fix shell script safety issues in manual revert
The shell commands need proper quoting and error handling.
- REVERT_PR=$(bash ./scripts/ci/revert-pr.sh "${{ github.event.pull_request.number }}")
- gh pr edit $REVERT_PR --add-label "automerge,high priority"
+ if ! REVERT_PR=$(bash ./scripts/ci/revert-pr.sh "${{ github.event.pull_request.number }}"); then
+ echo "Error: Failed to create revert PR"
+ exit 1
+ fi
+ gh pr edit "$REVERT_PR" --add-label "automerge" --add-label "high priority"Likely invalid or redundant comment.
81-82:
Fix shell script safety issues
The shell commands need proper quoting to prevent word splitting and potential issues.
- REVERT_PR=$(bash ./scripts/ci/revert-pr.sh "$PR_NUMBER")
- gh pr edit $REVERT_PR --add-label "automerge,high priority"
+ if ! REVERT_PR=$(bash ./scripts/ci/revert-pr.sh "$PR_NUMBER"); then
+ echo "Error: Failed to create revert PR"
+ exit 1
+ fi
+ gh pr edit "$REVERT_PR" --add-label "automerge" --add-label "high priority"Likely invalid or redundant comment.
28-28: Verify the custom runner label
The workflow uses a custom runner label ec2-runners. Please ensure this label is properly configured in your GitHub Actions settings or self-hosted runners configuration.
🧰 Tools
🪛 actionlint (1.7.4)
28-28: label "ec2-runners" is unknown. available labels are "windows-latest", "windows-latest-8-cores", "windows-2022", "windows-2019", "ubuntu-latest", "ubuntu-latest-4-cores", "ubuntu-latest-8-cores", "ubuntu-latest-16-cores", "ubuntu-24.04", "ubuntu-22.04", "ubuntu-20.04", "macos-latest", "macos-latest-xl", "macos-latest-xlarge", "macos-latest-large", "macos-15-xlarge", "macos-15-large", "macos-15", "macos-14-xl", "macos-14-xlarge", "macos-14-large", "macos-14", "macos-13-xl", "macos-13-xlarge", "macos-13-large", "macos-13", "macos-12-xl", "macos-12-xlarge", "macos-12-large", "macos-12", "self-hosted", "x64", "arm", "arm64", "linux", "macos", "windows". if it is a custom label for self-hosted runner, set list of labels in actionlint.yaml config file
(runner-label)
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Outside diff range and nitpick comments (2)
.github/workflows/revert-pr.yaml (2)
1-1: Fix typo in workflow nameThe workflow name "Checksuit" appears to be a typo. Consider changing it to "Checksuite" for better clarity and consistency.
-name: Checksuit +name: Checksuite
86-86: Improve condition readabilityThe job condition is complex and could benefit from being split into multiple conditions for better readability.
- if: ${{ github.event_name == 'pull_request' && contains(github.event.pull_request.labels.*.name, 'revert') && (github.event.pull_request.merged == true || github.event.pull_request.draft == true) && github.actor != 'github-actions' }} + if: | + ${{ + github.event_name == 'pull_request' && + contains(github.event.pull_request.labels.*.name, 'revert') && + (github.event.pull_request.merged == true || github.event.pull_request.draft == true) && + github.actor != 'github-actions' + }}
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
.github/workflows/revert-pr.yaml(1 hunks)
🧰 Additional context used
🪛 actionlint (1.7.4)
.github/workflows/revert-pr.yaml
28-28: label "ec2-runners" is unknown. available labels are "windows-latest", "windows-latest-8-cores", "windows-2022", "windows-2019", "ubuntu-latest", "ubuntu-latest-4-cores", "ubuntu-latest-8-cores", "ubuntu-latest-16-cores", "ubuntu-24.04", "ubuntu-22.04", "ubuntu-20.04", "macos-latest", "macos-latest-xl", "macos-latest-xlarge", "macos-latest-large", "macos-15-xlarge", "macos-15-large", "macos-15", "macos-14-xl", "macos-14-xlarge", "macos-14-large", "macos-14", "macos-13-xl", "macos-13-xlarge", "macos-13-large", "macos-13", "macos-12-xl", "macos-12-xlarge", "macos-12-large", "macos-12", "self-hosted", "x64", "arm", "arm64", "linux", "macos", "windows". if it is a custom label for self-hosted runner, set list of labels in actionlint.yaml config file
(runner-label)
42-42: shellcheck reported issue in this script: SC2086:info:5:34: Double quote to prevent globbing and word splitting
(shellcheck)
80-80: shellcheck reported issue in this script: SC2086:info:2:12: Double quote to prevent globbing and word splitting
(shellcheck)
96-96: shellcheck reported issue in this script: SC2086:info:2:12: Double quote to prevent globbing and word splitting
(shellcheck)
🔇 Additional comments (2)
.github/workflows/revert-pr.yaml (2)
80-82: 🛠️ Refactor suggestion
Improve script execution and label handling
The current implementation has potential issues:
- No error handling for the revert script
- Label addition uses a comma-separated string which is fragile
- REVERT_PR=$(bash ./scripts/ci/revert-pr.sh "$PR_NUMBER")
- gh pr edit $REVERT_PR --add-label "automerge,high priority"
+ if ! REVERT_PR=$(bash ./scripts/ci/revert-pr.sh "$PR_NUMBER"); then
+ echo "Failed to create revert PR"
+ exit 1
+ fi
+ gh pr edit "$REVERT_PR" --add-label "automerge" --add-label "high priority"🧰 Tools
🪛 actionlint (1.7.4)
80-80: shellcheck reported issue in this script: SC2086:info:2:12: Double quote to prevent globbing and word splitting
(shellcheck)
96-98: 🛠️ Refactor suggestion
Apply same improvements as create-revert-pr job
The script execution and label handling have the same issues as the create-revert-pr job.
- REVERT_PR=$(bash ./scripts/ci/revert-pr.sh "${{ github.event.pull_request.number }}")
- gh pr edit $REVERT_PR --add-label "automerge,high priority"
+ if ! REVERT_PR=$(bash ./scripts/ci/revert-pr.sh "${{ github.event.pull_request.number }}"); then
+ echo "Failed to create revert PR"
+ exit 1
+ fi
+ gh pr edit "$REVERT_PR" --add-label "automerge" --add-label "high priority"Likely invalid or redundant comment.
🧰 Tools
🪛 actionlint (1.7.4)
96-96: shellcheck reported issue in this script: SC2086:info:2:12: Double quote to prevent globbing and word splitting
(shellcheck)
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (2)
.github/workflows/revert-pr.yaml (2)
1-1: Rename workflow to better reflect its purposeThe name "Checksuit" is unclear. Consider renaming to something more descriptive like "PR Auto-Revert" or "Main Branch Protection - Auto-Revert".
-name: Checksuit +name: PR Auto-Revert
91-91: Improve readability of job conditionThe condition is complex and hard to read. Consider breaking it down using environment variables or job outputs.
- if: ${{ github.event_name == 'pull_request' && contains(github.event.pull_request.labels.*.name, 'revert') && (github.event.pull_request.merged == true || github.event.pull_request.draft == true) && github.actor != 'github-actions' }} + if: | + ${{ + github.event_name == 'pull_request' && + contains(github.event.pull_request.labels.*.name, 'revert') && + (github.event.pull_request.merged == true || github.event.pull_request.draft == true) && + github.actor != 'github-actions' + }}
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
.github/workflows/revert-pr.yaml(1 hunks)
🧰 Additional context used
🪛 actionlint (1.7.4)
.github/workflows/revert-pr.yaml
28-28: label "ec2-runners" is unknown. available labels are "windows-latest", "windows-latest-8-cores", "windows-2022", "windows-2019", "ubuntu-latest", "ubuntu-latest-4-cores", "ubuntu-latest-8-cores", "ubuntu-latest-16-cores", "ubuntu-24.04", "ubuntu-22.04", "ubuntu-20.04", "macos-latest", "macos-latest-xl", "macos-latest-xlarge", "macos-latest-large", "macos-15-xlarge", "macos-15-large", "macos-15", "macos-14-xl", "macos-14-xlarge", "macos-14-large", "macos-14", "macos-13-xl", "macos-13-xlarge", "macos-13-large", "macos-13", "macos-12-xl", "macos-12-xlarge", "macos-12-large", "macos-12", "self-hosted", "x64", "arm", "arm64", "linux", "macos", "windows". if it is a custom label for self-hosted runner, set list of labels in actionlint.yaml config file
(runner-label)
42-42: shellcheck reported issue in this script: SC2086:info:5:34: Double quote to prevent globbing and word splitting
(shellcheck)
71-71: label "ec2-runners" is unknown. available labels are "windows-latest", "windows-latest-8-cores", "windows-2022", "windows-2019", "ubuntu-latest", "ubuntu-latest-4-cores", "ubuntu-latest-8-cores", "ubuntu-latest-16-cores", "ubuntu-24.04", "ubuntu-22.04", "ubuntu-20.04", "macos-latest", "macos-latest-xl", "macos-latest-xlarge", "macos-latest-large", "macos-15-xlarge", "macos-15-large", "macos-15", "macos-14-xl", "macos-14-xlarge", "macos-14-large", "macos-14", "macos-13-xl", "macos-13-xlarge", "macos-13-large", "macos-13", "macos-12-xl", "macos-12-xlarge", "macos-12-large", "macos-12", "self-hosted", "x64", "arm", "arm64", "linux", "macos", "windows". if it is a custom label for self-hosted runner, set list of labels in actionlint.yaml config file
(runner-label)
82-82: shellcheck reported issue in this script: SC2086:info:2:12: Double quote to prevent globbing and word splitting
(shellcheck)
88-88: label "ec2-runners" is unknown. available labels are "windows-latest", "windows-latest-8-cores", "windows-2022", "windows-2019", "ubuntu-latest", "ubuntu-latest-4-cores", "ubuntu-latest-8-cores", "ubuntu-latest-16-cores", "ubuntu-24.04", "ubuntu-22.04", "ubuntu-20.04", "macos-latest", "macos-latest-xl", "macos-latest-xlarge", "macos-latest-large", "macos-15-xlarge", "macos-15-large", "macos-15", "macos-14-xl", "macos-14-xlarge", "macos-14-large", "macos-14", "macos-13-xl", "macos-13-xlarge", "macos-13-large", "macos-13", "macos-12-xl", "macos-12-xlarge", "macos-12-large", "macos-12", "self-hosted", "x64", "arm", "arm64", "linux", "macos", "windows". if it is a custom label for self-hosted runner, set list of labels in actionlint.yaml config file
(runner-label)
100-100: shellcheck reported issue in this script: SC2086:info:2:12: Double quote to prevent globbing and word splitting
(shellcheck)
🔇 Additional comments (4)
.github/workflows/revert-pr.yaml (4)
21-23: LGTM: Environment setup is secure
The GitHub token is properly configured using secrets.
28-28: Document custom runner label ec2-runners
The ec2-runners label is used across the workflow but lacks documentation. Add documentation in one of these locations:
- Create a README.md in
.github/workflows/directory explaining the custom runner setup - Add a comment in the workflow files where this label is used
- Create an actionlint configuration file to validate this custom label
🧰 Tools
🪛 actionlint (1.7.4)
28-28: label "ec2-runners" is unknown. available labels are "windows-latest", "windows-latest-8-cores", "windows-2022", "windows-2019", "ubuntu-latest", "ubuntu-latest-4-cores", "ubuntu-latest-8-cores", "ubuntu-latest-16-cores", "ubuntu-24.04", "ubuntu-22.04", "ubuntu-20.04", "macos-latest", "macos-latest-xl", "macos-latest-xlarge", "macos-latest-large", "macos-15-xlarge", "macos-15-large", "macos-15", "macos-14-xl", "macos-14-xlarge", "macos-14-large", "macos-14", "macos-13-xl", "macos-13-xlarge", "macos-13-large", "macos-13", "macos-12-xl", "macos-12-xlarge", "macos-12-large", "macos-12", "self-hosted", "x64", "arm", "arm64", "linux", "macos", "windows". if it is a custom label for self-hosted runner, set list of labels in actionlint.yaml config file
(runner-label)
82-85: 🛠️ Refactor suggestion
Improve script execution and label handling
The current implementation has several potential issues:
- No error handling for the revert script
- Label addition uses a comma-separated string which is fragile
- REVERT_PR=$(bash ./scripts/ci/revert-pr.sh "$PR_NUMBER")
- gh pr edit $REVERT_PR --add-label "automerge,high priority"
+ if ! REVERT_PR=$(bash ./scripts/ci/revert-pr.sh "$PR_NUMBER"); then
+ echo "Failed to create revert PR"
+ exit 1
+ fi
+ gh pr edit "$REVERT_PR" --add-label "automerge" --add-label "high priority"🧰 Tools
🪛 actionlint (1.7.4)
82-82: shellcheck reported issue in this script: SC2086:info:2:12: Double quote to prevent globbing and word splitting
(shellcheck)
100-102: 🛠️ Refactor suggestion
Fix script execution and label handling
Similar to the create-revert-pr job, improve error handling and label management.
- REVERT_PR=$(bash ./scripts/ci/revert-pr.sh "${{ github.event.pull_request.number }}")
- gh pr edit $REVERT_PR --add-label "automerge,high priority"
+ if ! REVERT_PR=$(bash ./scripts/ci/revert-pr.sh "${{ github.event.pull_request.number }}"); then
+ echo "Failed to create revert PR"
+ exit 1
+ fi
+ gh pr edit "$REVERT_PR" --add-label "automerge" --add-label "high priority"Likely invalid or redundant comment.
🧰 Tools
🪛 actionlint (1.7.4)
100-100: shellcheck reported issue in this script: SC2086:info:2:12: Double quote to prevent globbing and word splitting
(shellcheck)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
|
@coderabbitai resolve |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (3)
.github/workflows/revert-pr.yaml (3)
1-1: Consider a more descriptive workflow nameThe name "Checksuit" doesn't clearly convey the workflow's purpose of reverting PRs. Consider renaming to something more descriptive like "PR Auto-Revert" or "PR Revert Handler".
-name: Checksuit +name: PR Auto-Revert Workflow
94-94: Improve condition readabilityThe complex condition could be split into multiple lines for better readability.
- if: ${{ github.event_name == 'pull_request' && contains(github.event.pull_request.labels.*.name, 'revert') && (github.event.pull_request.merged == true || github.event.pull_request.draft == true) && github.actor != 'github-actions' }} + if: | + ${{ + github.event_name == 'pull_request' && + contains(github.event.pull_request.labels.*.name, 'revert') && + (github.event.pull_request.merged == true || github.event.pull_request.draft == true) && + github.actor != 'github-actions' + }}
21-22: Add documentation for environment variablesDocument the
ENABLE_PR_REVERTvariable and consider adding notifications to alert PR authors when their PRs are being reverted.Add a comment block explaining the configuration:
env: # GitHub token for API operations GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Note: ENABLE_PR_REVERT must be set to 'true' to enable PR reversion # This can be configured in repository variables
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
.github/workflows/revert-pr.yaml(1 hunks)
🧰 Additional context used
🪛 actionlint (1.7.4)
.github/workflows/revert-pr.yaml
28-28: label "ec2-runners" is unknown. available labels are "windows-latest", "windows-latest-8-cores", "windows-2022", "windows-2019", "ubuntu-latest", "ubuntu-latest-4-cores", "ubuntu-latest-8-cores", "ubuntu-latest-16-cores", "ubuntu-24.04", "ubuntu-22.04", "ubuntu-20.04", "macos-latest", "macos-latest-xl", "macos-latest-xlarge", "macos-latest-large", "macos-15-xlarge", "macos-15-large", "macos-15", "macos-14-xl", "macos-14-xlarge", "macos-14-large", "macos-14", "macos-13-xl", "macos-13-xlarge", "macos-13-large", "macos-13", "macos-12-xl", "macos-12-xlarge", "macos-12-large", "macos-12", "self-hosted", "x64", "arm", "arm64", "linux", "macos", "windows". if it is a custom label for self-hosted runner, set list of labels in actionlint.yaml config file
(runner-label)
42-42: shellcheck reported issue in this script: SC2086:info:8:34: Double quote to prevent globbing and word splitting
(shellcheck)
74-74: label "ec2-runners" is unknown. available labels are "windows-latest", "windows-latest-8-cores", "windows-2022", "windows-2019", "ubuntu-latest", "ubuntu-latest-4-cores", "ubuntu-latest-8-cores", "ubuntu-latest-16-cores", "ubuntu-24.04", "ubuntu-22.04", "ubuntu-20.04", "macos-latest", "macos-latest-xl", "macos-latest-xlarge", "macos-latest-large", "macos-15-xlarge", "macos-15-large", "macos-15", "macos-14-xl", "macos-14-xlarge", "macos-14-large", "macos-14", "macos-13-xl", "macos-13-xlarge", "macos-13-large", "macos-13", "macos-12-xl", "macos-12-xlarge", "macos-12-large", "macos-12", "self-hosted", "x64", "arm", "arm64", "linux", "macos", "windows". if it is a custom label for self-hosted runner, set list of labels in actionlint.yaml config file
(runner-label)
85-85: shellcheck reported issue in this script: SC2086:info:2:12: Double quote to prevent globbing and word splitting
(shellcheck)
91-91: label "ec2-runners" is unknown. available labels are "windows-latest", "windows-latest-8-cores", "windows-2022", "windows-2019", "ubuntu-latest", "ubuntu-latest-4-cores", "ubuntu-latest-8-cores", "ubuntu-latest-16-cores", "ubuntu-24.04", "ubuntu-22.04", "ubuntu-20.04", "macos-latest", "macos-latest-xl", "macos-latest-xlarge", "macos-latest-large", "macos-15-xlarge", "macos-15-large", "macos-15", "macos-14-xl", "macos-14-xlarge", "macos-14-large", "macos-14", "macos-13-xl", "macos-13-xlarge", "macos-13-large", "macos-13", "macos-12-xl", "macos-12-xlarge", "macos-12-large", "macos-12", "self-hosted", "x64", "arm", "arm64", "linux", "macos", "windows". if it is a custom label for self-hosted runner, set list of labels in actionlint.yaml config file
(runner-label)
103-103: shellcheck reported issue in this script: SC2086:info:2:12: Double quote to prevent globbing and word splitting
(shellcheck)
🔇 Additional comments (3)
.github/workflows/revert-pr.yaml (3)
28-28: Document custom runner label ec2-runners
The ec2-runners label is used but not documented. Add documentation in the workflow configuration.
🧰 Tools
🪛 actionlint (1.7.4)
28-28: label "ec2-runners" is unknown. available labels are "windows-latest", "windows-latest-8-cores", "windows-2022", "windows-2019", "ubuntu-latest", "ubuntu-latest-4-cores", "ubuntu-latest-8-cores", "ubuntu-latest-16-cores", "ubuntu-24.04", "ubuntu-22.04", "ubuntu-20.04", "macos-latest", "macos-latest-xl", "macos-latest-xlarge", "macos-latest-large", "macos-15-xlarge", "macos-15-large", "macos-15", "macos-14-xl", "macos-14-xlarge", "macos-14-large", "macos-14", "macos-13-xl", "macos-13-xlarge", "macos-13-large", "macos-13", "macos-12-xl", "macos-12-xlarge", "macos-12-large", "macos-12", "self-hosted", "x64", "arm", "arm64", "linux", "macos", "windows". if it is a custom label for self-hosted runner, set list of labels in actionlint.yaml config file
(runner-label)
85-87: 🛠️ Refactor suggestion
Improve script execution and label handling
The current implementation needs better error handling and label management.
- REVERT_PR=$(bash ./scripts/ci/revert-pr.sh "$PR_NUMBER")
- gh pr edit $REVERT_PR --add-label "automerge,high priority"
+ if ! REVERT_PR=$(bash ./scripts/ci/revert-pr.sh "$PR_NUMBER"); then
+ echo "Failed to create revert PR"
+ exit 1
+ fi
+ gh pr edit "$REVERT_PR" --add-label "automerge" --add-label "high priority"Likely invalid or redundant comment.
🧰 Tools
🪛 actionlint (1.7.4)
85-85: shellcheck reported issue in this script: SC2086:info:2:12: Double quote to prevent globbing and word splitting
(shellcheck)
103-105: 🛠️ Refactor suggestion
Add error handling for revert operation
Similar to the automated revert job, add proper error handling for the script execution and label addition.
- REVERT_PR=$(bash ./scripts/ci/revert-pr.sh "${{ github.event.pull_request.number }}")
- gh pr edit $REVERT_PR --add-label "automerge,high priority"
+ if ! REVERT_PR=$(bash ./scripts/ci/revert-pr.sh "${{ github.event.pull_request.number }}"); then
+ echo "Failed to create revert PR"
+ exit 1
+ fi
+ gh pr edit "$REVERT_PR" --add-label "automerge" --add-label "high priority"Likely invalid or redundant comment.
🧰 Tools
🪛 actionlint (1.7.4)
103-103: shellcheck reported issue in this script: SC2086:info:2:12: Double quote to prevent globbing and word splitting
(shellcheck)
✅ Actions performedComments resolved and changes approved. |
busla
added
automerge
busla
added
revert
Revert PRs on label
Support PR revert by setting the
revertlabel.Manual revert
Setting the
revertlabel automates the creation of a revert PR.Automated revert
When our checksuit fails on
maintherevertlabel is set on the merged PR automatically that triggers the revert process.Feature flag
The revert feature is disabled by default but can be enabled by updating the following github variable. With the flag disabled the workflow lifecycle will be triggered but the actual PR revert will not be created.
TODO
Summary by CodeRabbit
New Features
Bug Fixes
Documentation