Add auto merge #54
Add auto merge #54
Conversation
WalkthroughA new GitHub Actions workflow file named Changes
Poem
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
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Outside diff range and nitpick comments (2)
.github/workflows/automerge.yml (2)
1-2: Consider using more specific PR event triggersThe current trigger
pull_requestruns on all PR events, which might be inefficient. Consider using more specific event types or actions.name: Bot auto-merge -on: pull_request # yamllint disable-line rule:truthy +on: + pull_request: + types: [opened, synchronize, reopened] # yamllint disable-line rule:truthy
1-17: Consider implementing a more comprehensive bot automation strategyWhile this workflow handles basic auto-merge functionality, consider the following architectural improvements:
- Create a reusable workflow that can be shared across repositories
- Implement a configuration file to manage:
- Allowed bot users
- Repository names
- Merge strategies
- Required status checks
- Add monitoring and notifications for failed merges
- Consider implementing branch protection bypass configurations for trusted bots
Would you like assistance in implementing any of these improvements?
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
.github/workflows/automerge.yml(1 hunks)
🔇 Additional comments (1)
.github/workflows/automerge.yml (1)
4-7: LGTM! Appropriate permissions configuration
The permissions are correctly scoped to the minimum required for auto-merge functionality.
| autobot: | ||
| runs-on: ubuntu-latest | ||
| if: (github.event.pull_request.user.login == 'dependabot[bot]' || github.event.pull_request.user.login == 'pre-commit-ci[bot]') && github.repository == 'pyiron/conda_subprocess' |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add additional safety checks and make repository name configurable
While the bot filtering is good, consider adding more safety checks and making the workflow more reusable.
jobs:
autobot:
runs-on: ubuntu-latest
- if: (github.event.pull_request.user.login == 'dependabot[bot]' || github.event.pull_request.user.login == 'pre-commit-ci[bot]') && github.repository == 'pyiron/conda_subprocess'
+ if: |
+ (github.event.pull_request.user.login == 'dependabot[bot]' ||
+ github.event.pull_request.user.login == 'pre-commit-ci[bot]') &&
+ github.repository == vars.REPOSITORY_NAME &&
+ github.event.pull_request.mergeable == true &&
+ !github.event.pull_request.draftConsider storing the repository name in GitHub Variables for better maintainability.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| autobot: | |
| runs-on: ubuntu-latest | |
| if: (github.event.pull_request.user.login == 'dependabot[bot]' || github.event.pull_request.user.login == 'pre-commit-ci[bot]') && github.repository == 'pyiron/conda_subprocess' | |
| autobot: | |
| runs-on: ubuntu-latest | |
| if: | | |
| (github.event.pull_request.user.login == 'dependabot[bot]' || | |
| github.event.pull_request.user.login == 'pre-commit-ci[bot]') && | |
| github.repository == vars.REPOSITORY_NAME && | |
| github.event.pull_request.mergeable == true && | |
| !github.event.pull_request.draft |
| steps: | ||
| - name: Enable auto-merge for bot PRs | ||
| run: gh pr merge --auto --squash "$PR_URL" | ||
| env: | ||
| PR_URL: ${{github.event.pull_request.html_url}} | ||
| GH_TOKEN: ${{secrets.GITHUB_TOKEN}} |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Enhance merge step robustness
The current implementation could benefit from additional checks and error handling.
steps:
+ - name: Check if PR is ready to merge
+ run: |
+ if ! gh pr view "$PR_URL" --json mergeable,statusCheckRollup -q '.mergeable and all(.statusCheckRollup[].conclusion == "SUCCESS")'; then
+ echo "PR is not ready to merge"
+ exit 1
+ fi
+ env:
+ PR_URL: ${{github.event.pull_request.html_url}}
+ GH_TOKEN: ${{secrets.GITHUB_TOKEN}}
- name: Enable auto-merge for bot PRs
- run: gh pr merge --auto --squash "$PR_URL"
+ run: |
+ MAX_RETRIES=3
+ for i in $(seq 1 $MAX_RETRIES); do
+ if gh pr merge --auto --squash "$PR_URL"; then
+ exit 0
+ fi
+ echo "Merge attempt $i failed, retrying in 10s..."
+ sleep 10
+ done
+ echo "Failed to merge PR after $MAX_RETRIES attempts"
+ exit 1
env:
PR_URL: ${{github.event.pull_request.html_url}}
GH_TOKEN: ${{secrets.GITHUB_TOKEN}}📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| steps: | |
| - name: Enable auto-merge for bot PRs | |
| run: gh pr merge --auto --squash "$PR_URL" | |
| env: | |
| PR_URL: ${{github.event.pull_request.html_url}} | |
| GH_TOKEN: ${{secrets.GITHUB_TOKEN}} | |
| steps: | |
| - name: Check if PR is ready to merge | |
| run: | | |
| if ! gh pr view "$PR_URL" --json mergeable,statusCheckRollup -q '.mergeable and all(.statusCheckRollup[].conclusion == "SUCCESS")'; then | |
| echo "PR is not ready to merge" | |
| exit 1 | |
| fi | |
| env: | |
| PR_URL: ${{github.event.pull_request.html_url}} | |
| GH_TOKEN: ${{secrets.GITHUB_TOKEN}} | |
| - name: Enable auto-merge for bot PRs | |
| run: | | |
| MAX_RETRIES=3 | |
| for i in $(seq 1 $MAX_RETRIES); do | |
| if gh pr merge --auto --squash "$PR_URL"; then | |
| exit 0 | |
| fi | |
| echo "Merge attempt $i failed, retrying in 10s..." | |
| sleep 10 | |
| done | |
| echo "Failed to merge PR after $MAX_RETRIES attempts" | |
| exit 1 | |
| env: | |
| PR_URL: ${{github.event.pull_request.html_url}} | |
| GH_TOKEN: ${{secrets.GITHUB_TOKEN}} |
Summary by CodeRabbit