Product documentation

A clear workflow health check, from first scan to export.

Workflow Linter is designed for self-service Jira administration. Start with an on-demand scan, review evidence, resolve or suppress findings, and let scheduled scans keep the report current.

01

Quick start

  1. Open Jira settings, then choose Apps.
  2. Select Workflow Linter under the installed apps section.
  3. Choose Run first scan.
  4. Review findings in priority order and open each result for evidence and remediation.
Administrator access required

Workflow Linter appears on a Jira administration page because Jira restricts workflow configuration access to administrators.

02

Scanning

The app discovers global and project workflows with Jira Cloud REST v3 workflow search, then reads complete transition graphs through Jira's bulk workflow endpoint. The same deterministic analysis service powers on-demand and weekly scheduled scans.

  • Ordinary rate limits and temporary Jira failures are retried automatically.
  • The latest successful result remains available when a refresh fails.
  • Diagnostics classify failures without exposing raw Jira response bodies.
03

Understanding findings

Each finding includes severity, confidence, workflow context, exact evidence, impact, and remediation guidance. Factual findings identify structural defects. Heuristic findings identify designs that deserve administrator review.

Intentional designs can be suppressed without changing Jira. Suppression identifiers remain stable for the same workflow, rule, subject, and evidence.

04

Rule catalog

IDSeverityConfidenceDetects
WL001CriticalFactualNo initial transition
WL002HighHeuristicMultiple initial transitions
WL003CriticalFactualMissing transition target
WL004CriticalFactualDirected transition without a source
WL005CriticalFactualMissing transition source
WL006MediumFactualDeprecated status still present
WL007HighFactualStatus unreachable from the initial path
WL008HighFactualReachable non-Done dead end
WL009HighFactualReachable status with no path to Done
WL010HighHeuristicWorkflow has no Done-category status
WL011MediumHeuristicGlobal transition to Done exposes no validator metadata
WL012MediumHeuristicGlobal transitions dominate the workflow
WL013MediumHeuristicSame transition name leads to different targets
WL014Medium or HighHeuristicElevated status or transition complexity

Every result includes a stable ID and practical remediation. Heuristics are intentionally labeled and can be suppressed.

05

Exports

CSV and JSON exports contain the stored finding detail visible in the app. Use CSV for spreadsheet review and JSON for internal tooling or long-term evidence capture. When a storage warning is shown, lower-priority detail may be omitted while aggregate counts remain accurate.

06

Safety limits

  • Up to 1,000 workflows across 20 Jira API pages.
  • Detailed storage for the 200 highest-priority findings.
  • Up to 500 finding suppressions.
  • One bounded latest successful report rather than an accumulating history.
07

Troubleshooting

The first scan does not run

Confirm you opened Workflow Linter as a Jira administrator and retry. Open Show diagnostics for the failure class and timestamps.

A workflow or finding is missing

Check for workflow-limit or stored-report warnings. Aggregate counts remain intact even when lower-priority detail is bounded.

A finding is intentional

Use Suppress intentional exception. You can restore the finding later.

Still need help?

Email support@workflowlinter.com with the diagnostics block, approximate time, app version, and a description with sensitive tenant information removed. Never send passwords or API tokens.