Jira module · weave

Setup

Configure credentials via environment variables. We recommend sourcing them through 1Password or your secrets manager rather than committing them to the shell rc.

Official API reference

weave commands for this module are checked against the vendor's published API.

Jira Cloud REST API

Variable	Description	Status
JIRA_URL	Required for authentication.	required
JIRA_USER	Required for authentication.	required
JIRA_TOKEN	Required for authentication.	required

Sanity-check the wiring:

weave secrets check
weave jira --help
weave doctor   # reports JIRA_URL status

Capabilities

What this module can do, by entity and verb. ✓ means a working CLI surface; · means not (yet) wired.

Entity	find	list	show	do	snapshot	diff	apply
issue	✓	·	·	✓	·	·	·
project	·	✓	·	·	✓	✓	✓

Commands

Every registered CLI command, grouped by verb. Each example uses placeholder arguments — substitute real values for your environment.

find (1)

find issue

read

Find an issue by key (e.g. WEAVE-123).

weave jira find issue <key>

list (1)

list projects

read

List projects (paginated).

weave jira list projects <arg>

do (3)

do assign

write

Assign an issue to a user (Atlassian accountId).

weave jira do assign <key>

do comment

write

Add a comment to an issue.

weave jira do comment <key>

do transition

write

Transition an issue (requires --transition-id).

weave jira do transition <key>

snapshot / diff / apply are generated automatically from the State Kinds declared on this module — see the State kinds section below for per-kind details. Workflow: snapshot → edit YAML → diff → apply --yes (or confirm interactively; apply --dry-run previews the same diff).

State kinds

Resources this module can snapshot and diff; apply where the kind supports live writes (see Round-trip per kind). Always run diff before apply; use --yes in automation after review. Files live under .weave-state/jira/.

projects

snapshot diff apply

Jira projects — name and description are round-trippable.

Scope: —
Round-trip: Full round-trip — snapshot, diff, apply.

State file skeleton

module: jira
kind: projects
items:
  - # <fields specific to this kind — see snapshot output>

Workflows

End-to-end recipes from operators who already run this module in production. Copy, adapt, and put under change-control.

Project metadata audit

Snapshot projects, edit name/description, diff and apply.

weave jira snapshot projects
$EDITOR .weave-state/jira/<site>/projects.yaml
weave jira diff projects
weave jira apply projects

Look up one issue

weave jira find issue WEAVE-123

List projects

weave jira list projects

Transition an issue

weave jira do transition WEAVE-123 --transition-id <id>

Terraform parity

For each Terraform resource in the canonical provider, here's the equivalent live-API verb in weave. Use this as a migration cheat-sheet, not a 1:1 contract — weave deliberately stays in the live-state lane, not the desired-state lane.

Terraform resource	weave equivalent
jira_project	weave jira snapshot/diff/apply projects Name and description round-trip via REST v3.
jira_issue	weave jira find issue Issue transitions use do transition with --transition-id.

Troubleshooting & source

Missing credentials

Run weave doctor — it reports which env vars (including JIRA_URL) are set and which are blank.

Unexpected behaviour from a state apply

Re-run weave jira diff <kind> to confirm the controller's current state, then re-snapshot before the next apply. The driver always re-snapshots before diffing.

Open the source

The module lives at https://github.com/andy-broyles/weavewhatever/tree/main/src/weave/modules/jira. File a bug or feature request at https://github.com/andy-broyles/weavewhatever/issues.