stackatdocs

Docs

Commands

On this page

GitHub issues have no buttons, so you steer Stackat by replying on its issues. Start a line with /stackpaw and a command.

A reply on a Stackat issuetext
/stackpaw pr

Every command#

CommandWhat it does
/stackpaw prOpens the pull request for this upgrade now, even with automatic pull requests off: ready when nothing touches your files, a draft with the checklist otherwise. Answered with the link or the reason. See Pull requests.
/stackpaw ignoreStops tracking this tool in this repository and closes the issue as not planned.
/stackpaw trackUndoes ignore: tracks the tool again and reopens the issue.
/stackpaw reevaluateRewrites the issue once from the latest data. Issues are not edited otherwise.
/stackpaw wrong …Tells the Stackat team the issue is incorrect, and what is wrong.
/stackpaw missed …Tells the Stackat team something that matters is not in the issue.
/stackpaw note …Any other feedback for the Stackat team.

Or react 👍 or 👎 on the issue: Stackat counts those too. The Stackat team reads every wrong, missed and note; they are the most useful thing you can send.

Spellings that also work#

  • /stackat instead of /stackpaw, and the old /semapi;
  • a mention of the app: @stackpaw pr;
  • re-evaluate or refresh for reevaluate, and pull-request for pr.

Commands are not case-sensitive. A command must start its line; put several on separate lines of one comment if you need to.

What happens after you reply#

  • Stackat sees a command within about two minutes, scans that repository straight away and acts on it, so the answer matches a full scan's.
  • It answers each command with one line on the issue. For example, after /stackpaw ignore: "OK @alice: Stackat stops tracking Traefik in this repo and closes this issue. Reply /stackpaw track to undo."
  • /stackpaw pr is answered after the scan, with the pull request or the reason there is none.

Who may use them#

By default, everyone with a role in the repository may use every command: the account that owns it, members of its organisation and collaborators. On a private repository, everyone who can read it has a role.

On a public repository anyone can comment, so a comment from someone without a role is ignored silently: a stranger cannot close a security issue with /stackpaw ignore or ask for pull requests.

Limiting who may use them#

The commands that change something can be limited, one by one, with commands in .stackat.yml:

KeyGoverns
pr/stackpaw pr
ignore/stackpaw ignore and /stackpaw track, its undo
reevaluate/stackpaw reevaluate

Feedback (wrong, missed, note) and reactions cannot be limited: they stay open to everyone with a role.

.stackat.ymlyaml
commands:
  pr: ["@alice", maintain]          # Alice, and anyone with maintain or admin access
  ignore: ["@acme/security"]        # members of the security team (ignore and track)
  reevaluate: [write]               # anyone with write access or more

Someone with a role who is not allowed gets one reply on the issue, and nothing is done:

@bob: only `@acme/platform-team`, `@alice` or people with maintain access can ask for pull requests in this repository (commands in .stackat.yml).

Names in that reply are written as code, so the people and teams listed are not notified. The full rules, examples and the messages a broken list produces are on the commands option page.