Skip to content
terminal

GitHub Action

Slash Commands

v2.0.0 Latest version

Slash Commands

terminal

Slash Commands

Check comments for /commands

Installation

Copy and paste the following snippet into your .yml file.

              
- name: Slash Commands

              
  uses: xt0rted/[email protected]
Learn more about this action in xt0rted/slash-command-action

Choose a version

Slash Commands Action

CI CodeQL codecov

Check issue or pull request comments for /commands and trigger or block workflows based on them.

Usage

In the following example comments will be checked for the command /test (parameters are optional such as /test ui) and will only pass if the user who left the comment has admin access to the repo. It will only run on the initial comment, not on edits, and when the action runs it will add a reaction of 👀 to the comment indicating it was seen.

on: issue_comment
name: Issue Comments
permissions:
  issues: write
jobs:
  check_comments:
    name: Check comments for /test
    runs-on: ubuntu-latest
    steps:
      - name: Check for Command
        id: command
        uses: xt0rted/slash-command-action@v1
        with:
          command: test
          reaction: "true"
          reaction-type: "eyes"
          allow-edits: "false"
          permission-level: admin
      - name: Act on the command
        run: echo "The command was '${{ steps.command.outputs.command-name }}' with arguments '${{ steps.command.outputs.command-arguments }}'"

Options

Required

Name Allowed values Description
repo-token GITHUB_TOKEN (default) or PAT GITHUB_TOKEN token or a PAT.
command [a-zA-Z0-9_] The command to act on. You can test how your command will be parsed here.

Optional

Name Allowed values Description
reaction true (default), false Indicates if a reaction is left on the comment indicating it was seen.
reaction-type +1 (default), -1, laugh, confused, heart, hooray, rocket, eyes The reaction type to leave on the comment.
allow-edits true, false (default) Indicates if the action should run on comment edits, or the initial comment only.
permission-level admin, write (default), read, none The user's permission level needed to act on the command.

License

The scripts and documentation in this project are released under the MIT License