Rules and permissions

Two separate questions decide every button: does it show on this work item, and can this person press it. Cuelight answers the first with showWhen and the second with allow.groups.

When a button shows

Every condition in showWhen must hold. Within one list, any value is enough.

"showWhen": {
  "projects": ["SHOP"],
  "issueTypes": ["Bug", "Story"],
  "statuses": ["In Review"],
  "labelsNone": ["blocked"]
}

This shows the button on Bugs or Stories, and only in project SHOP, and only in In Review, and only without the blocked label.

  • Project keys and labels are case-sensitive, as in Jira.
  • Issue type and status names aren't. They match the English name or the name in your site's language, so In Review also matches a Turkish site's İNCELEMEDE.
  • Leave showWhen out and the action shows on every work item, in every project. Add projects to keep it to the projects you mapped.

Buttons that only come from the work

With availability: next-only, an action never shows from rules. It shows only when a report or offer suggests it, and it disappears when the suggestion expires or someone presses it.

Use it for steps that only make sense right after something else: Roll back staging after a deploy, Re-run tests after a failure, Deploy preview after a pull request opens. If you give a next-only action a showWhen, the editor warns that it's ignored.

Pressing a next step clears the other steps from the same run, since they were alternatives. An offered step clears on its own.

Who can press it

allow.groups lists Jira group names. A person can press the button if they're in at least one. Leave it empty and anyone who can see the work item can press it.

Cuelight checks groups on the server when the button is pressed, not only when the panel loads, and it checks again when a next step is pressed. A report or offer can suggest an action but never grants permission to run it.

What people see when they can't

Buttons aren't hidden from people who can't press them. They show disabled with the reason underneath, so nobody has to ask where a step went:

ReasonWhen
Only members of Release Managers can run this.The person isn't in any of the allow.groups
Another run of this action is in progress.concurrency is per-issue and a run is active
GitHub isn't connected yet. Ask a Jira admin to connect it in Cuelight settings.No GitHub token is saved
Couldn't check your permissions. Try again.Jira didn't return the person's groups
Cuelight's subscription isn't active. Ask a Jira admin to renew it under Settings → Apps → Manage apps.The trial or subscription has ended

The group name in the first message is written for people: release-managers shows as "Release Managers".

One run at a time

With the default concurrency: per-issue, an action can't start again on the same work item while a run of it is active. A run stops blocking when it reports a final status, or when no report arrives within 30 minutes. Set concurrency: none for actions that are safe to run in parallel.

Double clicks never start two runs.