Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

QA: add reusable merge conflict check workflow #3

Merged
merged 1 commit into from
Dec 22, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions .github/reusable-merge-conflict-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
name: Check PRs for merge conflicts

on:
workflow_call:
# Note: the following inputs from the eps1lon/actions-label-merge-conflict
# action runner are not made available as inputs for end-user workflows at this time.
# - repoToken: set to secrets.GITHUB_TOKEN, which should be fine in all cases (except forks).
# - retryAfter: defaults to 120 seconds.
# - retryMax: defaults to 5 times
# - continueOnMissingPermissions: defaults to false
#
# If at some point in the future, there would be a need, these can still be added.
inputs:
dirtyLabel:
description: "Name of the label which indicates that the branch is dirty."
type: string
required: false
default: "merge conflict"
removeOnDirtyLabel:
description: "Name of the label which should be removed."
type: string
required: false
default: ''
commentOnDirty:
description: "Comment to add when the pull request is conflicting. Supports markdown."
type: string
required: false
default: "A merge conflict has been detected for the proposed code changes in this PR. Please resolve the conflict by either rebasing the PR or merging in changes from the base branch."
commentOnClean:
description: "Comment to add when the pull request is not conflicting anymore. Supports markdown."
type: string
required: false
default: ''

jobs:
check-prs:
name: Merge conflict check

runs-on: ubuntu-latest
steps:
- name: "Create label if it doesn't exist"
uses: actions/github-script@v7
with:
script: |
try {
await github.rest.issues.createLabel({
...context.repo,
name: ${{ inputs.dirtyLabel }}
});
} catch(e) {
// Ignore if labels exist already.
}

- name: Check PRs for merge conflicts
uses: eps1lon/actions-label-merge-conflict@v3
with:
repoToken: ${{ secrets.GITHUB_TOKEN }}
dirtyLabel: ${{ inputs.dirtyLabel }}
removeOnDirtyLabel: ${{ inputs.removeOnDirtyLabel }}
continueOnMissingPermissions: ${{ inputs.continueOnMissingPermissions }}
commentOnDirty: ${{ inputs.commentOnDirty }}
commentOnClean: ${{ inputs.commentOnClean }}
Loading