https://github.com/xt0rted/slash-command-action
A GitHub Action to check comments for slash commands
https://github.com/xt0rted/slash-command-action
github-actions hacktoberfest slash-commands workflows
Last synced: over 1 year ago
JSON representation
A GitHub Action to check comments for slash commands
- Host: GitHub
- URL: https://github.com/xt0rted/slash-command-action
- Owner: xt0rted
- License: mit
- Created: 2019-08-19T06:25:37.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2025-03-31T01:10:31.000Z (over 1 year ago)
- Last Synced: 2025-04-03T04:34:46.830Z (over 1 year ago)
- Topics: github-actions, hacktoberfest, slash-commands, workflows
- Language: TypeScript
- Homepage:
- Size: 3.59 MB
- Stars: 67
- Watchers: 2
- Forks: 8
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Slash Commands Action
[](https://github.com/xt0rted/slash-command-action/actions/workflows/ci.yml)
[](https://github.com/xt0rted/slash-command-action/actions/workflows/codeql-analysis.yml)
[](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
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](https://regex101.com/r/7XptVD).
### 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)