How to get the target branch name using pull_request_review event on github actions #27154

so-amuk · 2020-07-08T17:33:06Z

so-amuk
Jul 8, 2020

I have multiple jobs in github actions. I want to run jobs based on specific branches only on pull_request_review event. I tried using github.ref, github.head_ref, github.base_ref but none of them worked as they only work on pull_request or push event. As it is described below:

image807×336 41 KB

So my question is how to get target branch name?

I created PR from branch “latest” to “master”

I tried following, but does not work for me. It skips the first job Job1

name: Github actions
on: 
    pull_request_review:
      types: [submitted]
jobs:
    Job1:
        name: Job1
        runs-on: ubuntu-latest
        if: github.ref == 'refs/heads/master'
        steps:
            -   name: trigger
                run: echo "Hii"
    Job2:
        name: Job2
        runs-on: ubuntu-latest
        if: github.ref != 'refs/heads/master'
        steps:
            -   name: trigger
                run: echo "Hello"

Then I tried different approach and that also doesn’t work:

job1.yaml

name: Github actions
on: 
    pull_request_review:
      types: [submitted]
    branches:
       - 'master'
jobs:
    Job1:
        name: Job1
        runs-on: ubuntu-latest
        steps:
            -   name: trigger
                run: echo "Hii"

job2.yaml

name: Github actions
on: 
    pull_request_review:
      types: [submitted]
    branches:
       - '*'
       - '!master'
jobs:
    Job2:
        name: Job2
        runs-on: ubuntu-latest
        steps:
            -   name: trigger
                run: echo "Hii"

So after trying these steps, none of them worked. Now I am looking for different approach of how to get target branch name and then use conditions based on branches and then run the jobs. If I can use the same approach then how to achieve it? If anyone has suggestion how to achieve this using same or different approach then please answer. Thanks in advance!

Answered by weide-zhou

Jul 9, 2020

Hi @so-amuk,

For pull_request_review event, please use ${{ github.event.pull_request.base.ref }} to get the target branch name.

The value comes from Github Context, for different event, the value name and location could be different. Please use below code to export the context:

      - name: Dump GitHub context
        env:
          GITHUB_CONTEXT: ${{ toJson(github) }}
        run: echo "$GITHUB_CONTEXT"

Follow the structure of the context, you can find the target branch name.
So your code can be fixed as below:

name: Github actions
on: 
    pull_request_review:
      types: [submitted]
jobs:
  Job1:
    name: Job1
    runs-on: ubuntu-latest
    if: github.event.pull_request.base.ref =…

View full answer

weide-zhou · 2020-07-09T05:29:43Z

weide-zhou
Jul 9, 2020

Hi @so-amuk,

For pull_request_review event, please use ${{ github.event.pull_request.base.ref }} to get the target branch name.

The value comes from Github Context, for different event, the value name and location could be different. Please use below code to export the context:

      - name: Dump GitHub context
        env:
          GITHUB_CONTEXT: ${{ toJson(github) }}
        run: echo "$GITHUB_CONTEXT"

Follow the structure of the context, you can find the target branch name.
So your code can be fixed as below:

name: Github actions
on: 
    pull_request_review:
      types: [submitted]
jobs:
  Job1:
    name: Job1
    runs-on: ubuntu-latest
    if: github.event.pull_request.base.ref == 'master'   # check the target branch if it's master
    steps:
        - name: trigger
          run: echo "Hii"
  Job2:
    name: Job2
    runs-on: ubuntu-latest
    if: github.event.pull_request.base.ref != 'master' # check the target branch if it's master
    steps:
        - name: trigger
          run: echo "Hello"

Please check my workflow for your reference.

GitHub

weide-zhou/Ticket2

Contribute to weide-zhou/Ticket2 development by creating an account on GitHub.

Thanks

0 replies

so-amuk · 2020-07-09T13:14:15Z

so-amuk
Jul 9, 2020
Author

@weide-zhou Thanks for your valuable answer. It worked for me.

0 replies

tb102122 · 2021-01-11T01:29:33Z

tb102122
Jan 11, 2021

Thanks for the hint.
Below the revised version for Windows.

      - name: Check for Changes
        id: git_diff
        run: |
          if ( $env:github_base_ref ) {
            # Pull Request
            git fetch origin "${{ github.base_ref }}" --depth=1
            $diff_result = (git diff --name-only "origin/${{ github.base_ref }}" ${{ github.sha }} )
            echo "Diff between origin/${{ github.base_ref }} and ${{ github.sha }}"
          }else {
            # Push
            git fetch origin ${{ github.event.before }} --depth=1
            $diff_result = (git diff --name-only ${{ github.event.before }} ${{ github.sha }} )
            echo "Diff between ${{ github.event.before }} and ${{ github.sha }}"
          }
          # echo $diff_result
          $search_result = [bool] ($diff_result | Select-String -Pattern '(CHANGELOG.md)|(.ps1)' -Quiet)
          # echo $search_result
          echo "::set-output name=diff::$search_result"

0 replies

dememax · 2023-09-06T07:35:49Z

dememax
Sep 6, 2023

In our case, it's even not base, but github.event.pull_request.head.ref.

As far as I can see, it's not in the official documentation yet?

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GitHub Community

How to get the target branch name using pull_request_review event on github actions #27154

{{title}}

Replies: 4 comments

{{title}}

{{title}}

{{title}}

{{title}}

Select a reply

GitHub Community

How to get the target branch name using pull_request_review event on github actions #27154

so-amuk Jul 8, 2020

Replies: 4 comments

weide-zhou Jul 9, 2020

weide-zhou/Ticket2

so-amuk Jul 9, 2020 Author

tb102122 Jan 11, 2021

dememax Sep 6, 2023

so-amuk
Jul 8, 2020

weide-zhou
Jul 9, 2020

so-amuk
Jul 9, 2020
Author

tb102122
Jan 11, 2021

dememax
Sep 6, 2023