xt0rted / slash-command-action Goto Github PK

View Code? Open in Web Editor NEW

63.0 4.0 8.0 3.75 MB

A GitHub Action to check comments for slash commands

License: MIT License

TypeScript 97.82% JavaScript 2.18%

github-actions workflows slash-commands hacktoberfest

slash-command-action's Introduction

Slash Commands Action

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

slash-command-action's People

Contributors

Stargazers

Watchers

Forkers

egernst kata-containers mozgiii jacobrask forgeforce niccolofei fairmoney

slash-command-action's Issues

Update action to run on node 16

Node 12 is deprecated so this needs to updated to node16 and a new major version released.

readme example

I just copy pasted that example in the readme and it doesn't work.

a) the steps is nested incorrectly
b) its missing the runs-on attr

Do not fail on every non-slash command

Currently, the task fails for every non-slash command, making the regular discussions on the PR impossible due to email spam from Github Actions.
Can we figure out a workaround for it?

Allow using `@` instead of `/`

Using @ instead of / would let you simulate mentioning github apps/bots. So instead of /do something you could do @some-bot do something.

Depends on #759

Support for collaborator roles

The Triage and Maintain roles need to be added. It looks like these aren't returned from the rest api, so this call will need to be switched to graphql.

Handle pull_request_review events

Get branch ref for pr comments and set it as an output value

When the issue_comment event is triggered on a PR the action payload is for the default branch not the PR branch. Because of this we need to do some magic to get the PR branch info and pass it along to the next action.

The idea is to do something like so:

on:
  issue_comment:
    types: created

jobs:
  lint:
    steps:
      - name: Check for Command
        id: command
        uses: xt0rted/[email protected]
        with:
          repo-token: ${{ secrets.GITHUB_TOKEN }}
          command: lint

      - name: Checkout Repo
        uses: actions/checkout@v1
        with:
          ref: ${{ steps.command.outputs.branch-ref }}

Allow `-` in the command

The regex being used matches a-zA-Z0-9_. Updating this to include - will let you match usernames which can't be done currently. Usernames have the following criteria:

Must start with a-zA-Z0-9
Can contain multiple - but not consecutively
Must end with a-zA-Z0-9

This is the current regex:

/^\/([\w]+)\b *(.*)?$/m

And this is what I'm thinking of switching to:

/^\/([a-zA-Z0-9]+(?:[-_][a-zA-Z0-9]+)*) *(.*)?$/m

Adding a reaction with insufficient permissions doesn't throw an error or log a warning

Depending on if the action is used on issues or pull requests the GITHUB_TOKEN or PAT needs issues: write or pull_requests: write permissions in order to add reactions. If the token doesn't have sufficient permission the code tries to add the reaction, and continues on even if it failed. This should at least check for the bad response and report an error but ideally it'd throw and not continue on.