github/command-action

IssueOps commands in GitHub Actions

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Maintainedlast commit Nov 26, 2025
License
MIT

Pinned Snippet

workflow.ymlSHA-pinned
uses: github/command@3442f3fa1efe01bdb024b157083c337902d17372 # v2.0.3

tags can be moved; commit SHAs can't. why a SHA?

namedescriptionrequireddefault
github_tokenThe GitHub token used to create an authenticated client - Provided for you by default!yes${{ github.token }}
statusThe status of the GitHub Actions - For use in the post run workflow - Provided for you by default!yes${{ job.status }}
commandThe string to look for in comments as an IssueOps trigger/command. Example: ".lint"yes
reactionIf set, the specified emoji "reaction" is put on the comment to indicate that the trigger was detected. For example, "rocket" or "eyes"yeseyes
success_reactionThe reaction to add to the comment that triggered the Action if its execution was successfulyes+1
failure_reactionThe reaction to add to the comment that triggered the Action if its execution failedyes-1
allowed_contextsA comma separated list of comment contexts that are allowed to trigger this IssueOps command. Pull requests and issues are the only currently supported contextsyespull_request
permissionsThe allowed GitHub permissions an actor can have to invoke IssueOps commands - Example: "write,admin"yeswrite,admin
allow_draftsWhether or not to allow this IssueOps command to be run on draft pull requestsyesfalse
allow_forksWhether or not to allow this IssueOps command to be run on forked pull requestsyesfalse
skip_ciWhether or not to require passing CI checks before this IssueOps command can be runyesfalse
skip_reviewsWhether or not to require reviews before this IssueOps command can be runyesfalse
param_separatorThe separator to use for parsing parameters in comments in IssueOps commands. Parameters will are saved as outputs and can be used in subsequent stepsyes|
allowlistA comma separated list of GitHub usernames or teams that should be allowed to use the IssueOps commands configured in this Action. If unset, then all users meeting the "permissions" requirement will be able to run commands. Example: "monalisa,octocat,my-org/my-team"nofalse
allowlist_patA GitHub personal access token with "read:org" scopes. This is only needed if you are using the "allowlist" option with a GitHub org team. For example: "my-org/my-team"nofalse
skip_completingIf set to "true", skip the process of completing the Action. This is useful if you want to customize the way this Action completes - For example, custom reactions, comments, etcyesfalse
fork_review_bypassIf set to "true", allow forks to bypass the review requirement if the operation is being made on a pull request from a fork. This option is potentially dangerous if you are checking out code in your workflow as a result of invoking this Action. If the code you are checking out has not been reviewed, then you might open yourself up to a TOCTOU vulnerability. You should always ensure that the code you are checking out has been reviewed, and that you checkout an exact commit sha rather than a ref.yesfalse
namedescription
triggeredThe string "true" if the trigger was found, otherwise the string "false" - Just because the workflow was triggered does not mean it should continue. This is a step 1/2 check
continueThe string "true" if the workflow should continue, otherwise empty - Use this to conditionally control if your workflow should proceed or not. This is a step 2/2 check
comment_bodyThe comment body
actorThe GitHub handle of the actor that invoked the IssueOps command
paramsThe raw parameters that were passed into the IssueOps command
comment_idThe comment id which triggered this action
issue_numberThe issue number which this Action was triggered on
initial_reaction_idThe reaction id for the initial reaction on the trigger comment
forkThe string "true" if the pull request is a fork, otherwise "false"
fork_refThe true ref of the fork
fork_labelThe API label field returned for the fork
fork_checkoutThe console command presented in the GitHub UI to checkout a given fork locally
fork_full_nameThe full name of the fork in "org/repo" format
shaThe commit sha if being used in the context of a pull request
refThe ref if being used in the context of a pull request
base_refThe base ref that the pull request is merging into (if available and run in the context of a pull request)