Documentation

User guide

RuleSignal reviews a Jira automation JSON export before import, activation, migration, or handover. It reports static risks with evidence and remediation. It does not modify Jira.

Start with the practical export preflight checklist for a product-independent review sequence.

Analyze an export

In Jira administration, export the automation rules you want to review as JSON.
Open RuleSignal from Jira administration.
Choose or drop the JSON file.
Wait for the local browser-worker analysis.
Review score, coverage, severity filters, and finding cards.
Download an offline HTML or JSON report if needed.

Atlassian's automation import and export instructions

Interpret the result

Critical: documented hard limit or strong cycle evidence that should be resolved before activation.
High: substantial execution, scope, guard, or loop risk.
Medium: maintainability or operational risk requiring review.
Low: inventory hygiene recommendation.
Not evaluated: the export does not contain enough evidence. This is never treated as a pass.

The readiness score is a prioritization aid, not a certification and not proof that a rule is broken.

Compare two exports

Expand Compare two exports locally.
Select the earlier export as the baseline.
Select the newer export as the current export.
Review added, removed, changed, and unchanged counts.
Export comparison JSON or the self-contained offline HTML comparison.

Rules are matched by stable Jira rule ID first. If IDs differ, RuleSignal uses a unique normalized name only when that name occurs exactly once in both files. Duplicate names are deliberately not guessed.

Reports and fingerprints

Analysis and comparison outputs include local SHA-256 fingerprints of canonicalized JSON content. Equivalent whitespace and object-key order produce the same fingerprint; a content change produces a different one. A fingerprint identifies reviewed content but is not a digital signature and does not prove who created the export.

Troubleshooting

Input errors include a stable, payload-free code. Retry only with a fresh export; never send the raw file to support.

Fix findings in Jira, not in the JSON export. Every RS001-RS030 finding identifies the evidence and affected rule, explains why it matters, gives a Jira-side next action, and shows a concrete pattern plus an example safer target. JSON-shaped examples are used only where they are truthful; structural and cross-rule checks use workflow examples. Apply the correction in Jira, then export and analyze again.

RS-INPUT-001 · File exceeds 5 MB: Create smaller automation exports and analyze each separately.
RS-INPUT-002 · Invalid JSON: Export again from Jira automation settings and select the untouched file.
RS-INPUT-003 · No rules found: Select an automation-rule export rather than an issue or project export.
RS-INPUT-004 · Unsupported shape: Export directly from Jira Cloud automation. If it repeats, share only sanitized top-level keys.
RS-INPUT-005 · Unsafe nesting depth: Do not edit or retry the file. Report the code and a sanitized minimal structure.
RS-INPUT-006 · Wrong file type: Select the .json file created by Jira automation export.
RS-INPUT-007 · Analysis timeout: Reload RuleSignal, run the synthetic example, then retry the untouched export once.
RS-INPUT-900 · Unexpected analysis error: Reload, run the synthetic example, and report the code if the problem persists.

Unknown components after a successful analysis: retain the format fingerprint and report only the sanitized component shape.