Replace baseRefName with headRefName

[tannerhallman]

Thanks for your work on this GH Action - Its going to be great for visibility for my team. I tried using the action with this setup:

name: 'PR Conflicts'
on:
  # So that PRs touching the same files as the push are updated
  push:
  # So that the `dirtyLabel` is removed if conflicts are resolve
  # We recommend `pull_request_target` so that github secrets are available.
  # In `pull_request` we wouldn't be able to change labels of fork PRs
  pull_request_target:
    types: [synchronize]

jobs:
  main:
    runs-on: ubuntu-latest
    steps:
      - name: Check if PRs have conflicts
        uses: eps1lon/[email protected]
        with:
          dirtyLabel: 'PR: Has Conflicts'
          removeOnDirtyLabel: 'PR: Confirmed No Conflicts'
          repoToken: '${{ secrets.GITHUB_TOKEN }}'
          commentOnDirty: 'This pull request has conflicts, please resolve those before we can evaluate the pull request.'
          commentOnClean: 'Conflicts have been resolved. A maintainer will review the pull request shortly.'

However, it wasn't working at all. Using the debug logs, it was returning an empty array response for the query. I used the Github graphql explorer to debug.

What I ended up finding is that the getBranchName query used to populate the baseRefName in the query was seemingly the issue.

baseRefName for my case when I have a PR branched off of dev (long standing environment branch - similar to main/master), the baseRefName of that PR would actually be dev. headRefName in my findings actually was the branch name. It seems that the intention of the query, based on the function name getBranchName, was to filter the query by the actual branch name (headRefName) not the baseRefNamewhich seems to the be branch name that this PR is branched off.

So when I changed the query, my results returned the PR I expected, and thus the gh action was successful.

Here's some screenshots to back it up:

(before my work)

Screenshot showing the baseRefName as printed by the action debug logs:

Screenshot of using that in the query, as your action uses. Notice the empty results:

(After my work)

Screenshot of using the query filter headRefName instead:

Screenshot of gh actions response logs with this change:

Proof of it working!

As it seems, there was a mixup in the baseRefName and headRefName var. Please let me know if you have any questions!

Anyone reading can use my version of the gh action until this PR is merged. I will keep it up!
tannerhallman/actions-label-merge-conflict@main

[eps1lon]

Could you share a repo or order of events that you think is bugged? I don't think what you're proposing is what I originally wanted to do with this action

[eps1lon]

This query is for getting all PRs targetting the same branch. But head is the branch of the PR, no? I want the common base of the branches.

[tannerhallman]

baseRefName is dev in my case, the "head" that all my PRs are branched off of. headRefName is actually the branch of the PR. You can see that here:

Repo from my screenshots & testing is a private one. I can try to set you up with a public one.

But what I can tell you is that by merging the branch with the new action into dev, and pushing code to dev, the action was triggered on all PRs that were based off of dev and thus have been labeled. And I did check each to confirm there actually are conflicts.

Was this your intended behavior?

[github-actions]

This pull request has conflicts, please resolve those before we can evaluate the pull request.