Readme.md

Pull Request Comment Trigger

Look for a "trigger word" in a pull-request description or comment, so that later steps can know whether or not to run.

⚠️ This is a fork of the Khan/pull-request-comment-trigger action (marketplace), with upgrades for deprecated GitHub Actions functionality:

• 2022-10-11-github-actions-deprecating-save-state-and-set-output-commands
• 2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12

See the upstream pull request chore: GitHub upgrades #46 for more details.

Example usage in a workflow

Your workflow needs to listen to the following events:

on:
  pull_request:
    types: [opened]
  issue_comment:
    types: [created]

And then you can use the action in your jobs like this:

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: shanegenschaw/pull-request-comment-trigger@v2.2.0
        id: check
        with:
          trigger: '@deploy'
          reaction: rocket
        env:
          GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
      - run: 'echo Found it!'
        if: steps.check.outputs.triggered == 'true'

You can either pass arguments in your comment, e.g. @deploy dev:

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: shanegenschaw/pull-request-comment-trigger@v2.2.0
        id: check
        with:
          trigger: '@deploy **'
          reaction: rocket
          allow_arguments: true
        env:
          GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
      - run: 'echo Found it! Deploy on ${{ fromJson(steps.check.outputs.arguments)[0] }}'
        if: steps.check.outputs.triggered == 'true'

Reaction must be one of the reactions here: https://developer.github.com/v3/reactions/#reaction-types And if you specify a reaction, you have to provide the GITHUB_TOKEN env vbl.

Inputs

Input	Required?	Description
trigger	Yes	The string to look for in pull-request descriptions and comments. The trigger should be placed at the beginning. For example "#build/android".
reaction	No (default '')	If set, the specified emoji "reaction" is put on the comment to indicate that the trigger was detected. For example, "rocket".
allow_arguments	No (default 'false')	If 'true', script looks for ** markers that are considered as comment arguments.

Outputs

Output	Description
triggered	'true' or 'false' depending on if the trigger phrase was found.
comment_body	The comment body.
arguments	The comment arguments.