README.md

Payload Info

This action extracts info from the webhook payload object in Github Actions using filters based on the jq tool. It also provides the name of the branch this workflow is running on and if it is a pull request or not.

Check out the .github/workflows/main.yml file to see this action working.

Inputs

filter_push

Required Filter to be applied to the webhook payload object in case of a push. Default ".".

Learn more about filters at the jq manual.

filter_pull_request

Filter to be applied to the webhook payload object in case of a pull request. Default ".pull_request.".

Learn more about filters at the jq manual.

filter_prefix

String to be prefixed to all filters. Default ".[]".

dump

If the webhook payload should be dumped as a JSON file or not. Default true.

dump_path

Path to the JSON file that will house the dumped webhook payload. Default "gh-payload.json".

print

If the webhook payload should be output. Default true.

Outputs

value

Result of the filter applied to the webhook payload. If this the workflow is on a regular push (not pull request), value contains the result of the filter_push filter. If the workflow is on a pull request, value contains the result of the filter_pull_request filter.

branch

Name of the branch related to this workflow, e.g. "master".

pull_request

If this workflow is running on a pull request or not, e.g. "false".

Example usage

- uses: Dovyski/payload-info-action@master
  with:
    filter_push: '.commits[].author'
    filter_pull_request: '.pull_request.commits'