Get list of files on pull request merge

[addietrr]

If I have the following workflow to trigger on a pull request merge:

name: deployment
on:

pull_request:

types:

- closed
jobs:

job1:

runs-on: ubuntu-latest
steps:
- name: Check out
  uses: actions/checkout@v1

- name: get list of files in PR
  if: github.event.pull_request.merged
  run: |
    ???

What is the best way to get a list of files in the PR?

[weide-zhou]

You can use rest api to get the file list of pull request. Please refer to the link for more details.

Code sample as below, use jq to filter the filename.

- name: list files
        run: |
          URL="https://api.github.com/repos/${GITHUB_REPOSITORY}/pulls/${{ github.event.pull_request.number }}/files"
          FILES=$(curl -s -X GET -G $URL | jq -r '.[] | .filename')
          echo $FILES

pullrequestfiles.png706×227 6.68 KB

[luchiago]

Hi @weide-zhou. Your snippet was very helpful, but I’m having some trouble and I don’t understand why, could you help me?

error.png977×279 37.4 KB

[weide-zhou]

Hi @luchiago ,

The error is due to no json file changes in your pull request, which caused command ’FILES=$(curl … | | grep -E ‘.(json)$’)‘ to be failed.

You can check in this way:

- id: changes
        run: |
          URL="https://api.github.com/repos/${{ github.repository }}/pulls/${{ github.event.pull_request.number }}/files"
          FILES=$(curl -s -X GET -G $URL | jq -r '.[] | .filename')
          if echo $FILES | grep -q ".json"; then
            echo "json file changed!!"
          else
            echo "no json file changed!!"
          fi

Thanks.

[luchiago]

Thanks @weide-zhou. It worked

[PfanP]

weide-zhou:

FILES=$(curl -s -X GET -G $URL | jq -r '.[] | .filename')

Hi @weide-zhou Thanks for your reply. It’s very helpful but I’m getting error like
Cannot index string with string "filename"

Thanks
Khanh

[weide-zhou]

Hi @self-coding-crab,

I notice you parsed ‘.json’ in your jq filter, it should be ‘.filename’ from the curl command. I confirmed the script works on my side.

Basically you can check the curl command without jq, check the response body, and then use jq to filter the file.

image902×385 19.4 KB

If i checked the incorrect workflow, please let me know.

Thanks

[ksrisurapaneni]

Hi @weide-zhou ,

I am seeing the same error, below is the command I am running. I am using a private repo, do we have to include some sort of authentication in the curl command so it takes the GITHUB_TOKEN?

jq: error (at <stdin>:4): Cannot index string with string "filename"

URL="https://api.github.com/repos/${{ github.repository }}/pulls/${{ github.event.pull_request.number }}/files"`
FILES=$(curl -s -X GET -G $URL | jq -r '.[] | .filename')

if echo $FILES | grep -q "Dockerfile"; then

echo "Dockerfile file changed!!"

else

echo "No Dockerfile file changed!!"

fi

Can you please help me figure out what I am doing wrong?

Thanks,
Keerti

[mattt]

ksrisurapaneni:

I am using a private repo, do we have to include some sort of authentication in the curl command so it takes the GITHUB_TOKEN?

Yes, you’ll need to pass GITHUB_TOKEN to access non-public resources in your workflow. See
“Using the GITHUB_TOKEN in a workflow” for more information.

URL="https://api.github.com/repos/${{ github.repository }}/pulls/${{ github.event.pull_request.number }}/files"`
FILES=$(curl -s -X GET -H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" $URL | jq -r '.[] | .filename')

if echo $FILES | grep -q "Dockerfile"; then

echo "Dockerfile file changed!!"

else

echo "No Dockerfile file changed!!"

fi

[ksrisurapaneni]

Hi @mattt , thank you for responding. Your command works perfectly for pull events since the URL is taking info from a pull API. But it fails for push events or when we merge the PR.

So, I am using the below instead which works for both pull and push events:

github.com

jitterbit/get-changed-files

Get all of the files changed/modified in a pull request or push's commits.

Thank you,
Keerti