slash-command-action

KO | EN

gitlite — search

#javascript #typescript #deep-learning #nodejs #css #python #vue #php #react #java #game #docker

slash-command-action

★ 69 Open GitHub ↗

A GitHub Action to check comments for slash commands

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Slash Commands Action

[![CI](https://github.com/xt0rted/slash-command-action/workflows/CI/badge.svg?branch=main)](https://github.com/xt0rted/slash-command-action/actions/workflows/ci.yml)
[![CodeQL](https://github.com/xt0rted/slash-command-action/actions/workflows/codeql-analysis.yml/badge.svg?branch=main)](https://github.com/xt0rted/slash-command-action/actions/workflows/codeql-analysis.yml)
[![codecov](https://codecov.io/gh/xt0rted/slash-command-action/branch/main/graph/badge.svg)](https://codecov.io/gh/xt0rted/slash-command-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 :eyes: to the comment indicating it was seen.

```yaml
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

### 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](https://developer.github.com/v3/reactions/#reaction-types) 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](https://developer.github.com/v3/repos/collaborators/#review-a-users-permission-level) needed to act on the command.

## License

The scripts and documentation in this project are released under the [MIT License](LICENSE)

slash-command-action

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README