WIPGate documentation
What WIPGate does
WIPGate sets work-in-progress limits that Jira checks when work moves. Each limit is a rule: which work it covers (JQL), which statuses count as in progress, what it counts per (in total, per person, or per value of a field) and the limit. A workflow validator refuses a move that would go over a limit, and the WIP overview (Apps > WIP limits) shows every rule's count.
Set up in five minutes
- Create a rule. Jira settings > Apps > WIPGate > Rules > New WIP limit. Pick a template
(Column group, Personal WIP, Class of service, Shared across teams), then fill in:
- Work this rule covers: JQL such as
project = SHOPorproject in (SHOP, APP) AND component = Checkout. Several projects or boards in one rule share one limit. - Statuses that count as in progress: one or more. More than one makes a column group: one combined limit, and moving between them is never blocked.
- Count: in total, per person, or per value of a field.
- Limit, and for per-person or per-value rules any individual limits.
- When over the limit: Block the move, or Allow and log (warn mode).
- Work this rule covers: JQL such as
- Check it. "Check against current work" shows what the rule counts right now, per person or value, before you save.
- Add the validator to your workflow. Jira settings > Work items > Workflows (team-managed: Project settings > Workflow). Edit the workflow, select a transition into a limited status, Rules > Add rule > Validate details > WIP limit (WIPGate). Use the transition from "Any status" to cover every move into that status at once. Publish.
- Try it. Drag a card into the column on any board. If the limit is reached, Jira shows WIPGate's message and the card stays where it was.
Tip: start new rules in warn mode for a week. The activity log shows how often the limit would have stopped a move; then switch to Block.
Kinds of limits
| You want | Count | Example |
|---|---|---|
| One limit across Build and Review | In total, two statuses | 6 across In Progress + In Review |
| Each person holds at most two items | Per person | Default 2, Ana 1 (part time) |
| Expedite at most one, Standard at most five | Per value of "Class of service" | Expedite 1, Fixed date 2, Standard 5 |
| Two teams' boards share one limit | In total, scope project in (SHOP, APP) | 14 across the release train |
| A limit per swimlane | In total, scope = the swimlane's JQL | project = SHOP AND component = Payments: 3 |
Per-value limits work with select lists (single and multiple), labels, components, priority,
work type and parent. Type values as Jira shows them (for example Expedite). With no default
limit, only the values you list are limited.
Exceptions
- Never count, always allow (JQL): work matching this JQL is not counted and can always move
in, for example
labels = expedite OR priority = Highest. Work with no labels still counts. - Groups that may go over the limit: their moves go through and appear as overrides in the activity log. Groups are stored by id, so renaming a group keeps working; if a group is deleted, admins see a warning.
- Sub-tasks are not counted unless you tick "Count sub-tasks too", so a story with five sub-tasks counts once.
What the validator covers
Jira runs the validator on every transition it is added to, however the move starts: dragging a card on any board, the status button in the work item view, the mobile apps, bulk change and the REST API. Moves into statuses no rule covers cost nothing: WIPGate makes no Jira calls for them.
Reassigning work without changing its status is not a transition, so Jira does not run validators on it. WIPGate logs a reassignment that puts someone over a personal limit ("Reassigned over limit") and the overview shows it.
If an assignee is set on the transition screen, the limit counts for that person.
The WIP overview and the dashboard widget
Apps > WIP limits shows every active rule: the count against the limit, per person or value, with "View work" links to Jira search, and blocked moves, warnings and overrides for the last seven days. Counts follow each viewer's Jira permissions. Jira admins also see recent activity.
Add the WIP limits (WIPGate) widget to any dashboard and pick which rules it shows.
Settings
- When WIPGate cannot check a limit (Jira search unavailable, a rule's JQL broke): let the move through and log it (default), or refuse it.
- Add to every block message: one line such as "Ask in #team-flow if this is urgent."
Questions
- Does WIPGate change my boards? No. Jira's own column limits and their red headers stay as they are. WIPGate works on the move, not on the board's drawing.
- Can a limit be passed by one? If two people move work into the same limit at the same moment, both checks can pass. The overview shows it and the next move is blocked.
- What happens if the subscription lapses? Nothing is blocked any more and rules cannot be changed; rules are kept for when it is renewed.
- Where is my data? In your site's Forge storage, hosted by Atlassian. Nothing is sent to Great Work or anyone else.