Skip to content

docs(jira): say which built-in agents handle Jira work items - #8882

Closed
jwm4 wants to merge 1 commit into
mainfrom
docs/jira-guide-code-agent
Closed

jwm4 wants to merge 1 commit into
mainfrom
docs/jira-guide-code-agent

Conversation

@jwm4

@jwm4 jwm4 commented Oct 28, 2026

Copy link
Copy Markdown
Contributor

Summary

The Jira integration guide says every built-in agent's pre/post scripts expect a GitHub issue number, so Jira-dispatched runs fail, and that all substantive output goes to GitHub (citing #2264). That is out of date for triage and code. This PR says what each built-in agent does with a Jira work item today.

Draft: I'm about to test the Jira poller with the code agent on a real repo, and I expect to add whatever else that turns up before asking for review.

Related Issue

Related to #2264, #2265, #2266, #6672

Changes

All in docs/guides/user/jira-integration.md:

  • Event semantics: replace "output goes to GitHub" with a per-agent list:
    • Triage reads the Jira issue and writes its comment, labels, components and close transitions back to it (harness/triage.yaml Jira overlay, scripts/lib/jira-triage-ops.lib.sh in fullsend-ai/agents).
    • Code reads the Jira issue with a read-only credential and opens a GitHub PR on branch agent/<KEY>-<slug>, with the key in the title and a link to the Jira issue in the body; it posts no Jira comment (harness/code.yaml Jira overlay, scripts/pre-code-jira.sh, scripts/post-code.src.sh; Add JIRA support to the code agent #2265 is closed).
    • Prioritize has no Jira overlay yet (harness/prioritize.yaml; Add JIRA support to the prioritize agent #2266).
    • Review, fix and retro are not dispatched by a Jira issue (unchanged, now stated in one place).
  • Repo configuration: drop "dispatched agent runs will not complete successfully", and note that the default code harness has no trigger, so a repo must add one for /fs-code or ready-to-code on Jira to dispatch it.
  • Troubleshooting: replace the "fails immediately (Preserve Jira work-item identity through agent execution #2264)" row with a row for the missing code trigger and a row for prioritize (Add JIRA support to the prioritize agent #2266).

#2264 is still open. I haven't touched it here, but the triage Jira overlay looks like it covers what the issue asks for.

#8678 also edits the lines around the Event semantics section, so whichever PR lands second will need a small rebase.

Testing

  • lychee --offline --include-fragments on the guide: 0 errors
  • pre-commit hooks pass on the file
  • make lint (not run; docs-only change)
  • Tests added/updated: n/a, docs only

Checklist

  • PR title follows Conventional Commits
  • Commits are signed off (DCO)
  • I wrote this contribution myself and can explain all changes in it

🤖 Generated with Claude Code

The Jira integration guide said every built-in agent's pre/post scripts
expect a GitHub issue number and that Jira-dispatched runs fail, citing
#2264. That is out of date. In fullsend-ai/agents, the triage and code
harnesses both select a Jira overlay when event.source.system is jira:
triage writes its comment, labels, components and close transitions back
to the Jira issue, and code reads the issue with a read-only credential
and opens a GitHub pull request named after the Jira key (#2265, closed).
Prioritize still has no Jira overlay (#2266).

Describe each agent's behaviour, note that the default code harness has
no trigger, and replace the stale troubleshooting row.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Bill Murdock <bmurdock@redhat.com>
@fullsend-ai-review

fullsend-ai-review Bot commented Oct 28, 2026 •

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 12:34 PM UTC · Completed 12:44 PM UTC

Commit: 1f322e7 · View workflow run →

Runtime: pi · Model: sonnet → claude-sonnet-5-5 · Effort: high · Cost: $1.64

@github-actions

Copy link
Copy Markdown

Site preview

Preview: https://901e071d-site.fullsend-ai.workers.dev

Commit: 1f322e735a727ca0c054d94190f20ccb8ca7ab96

@fullsend-ai-review fullsend-ai-review Bot added the risk/moderate PR risk: moderate label Oct 28, 2026
@fullsend-ai-review

Copy link
Copy Markdown

<!-- fullsend:risk-assessment -->
Risk Assessment: moderate (2/5)

Details

While this is a single-file documentation update with low metadata risk, high recent regression history and multi-author churn on the Jira integration guide elevate the composite risk to moderate.

@fullsend-ai-review

Copy link
Copy Markdown

Review

Findings

Low

  • [stale-doc] docs/guides/user/issues-commands.md:10 — The "When to use" text says the built-in pipeline posts comments automatically "for GitHub-sourced events" and presents posting back to Jira as a custom-agent use case. This PR documents that the built-in triage agent now writes back to Jira, so the page is incomplete. The triage Jira overlay lives in fullsend-ai/agents and could not be checked from this checkout.
    Remediation: Optionally add a sentence saying built-in triage writes back to Jira for Jira-sourced events, so --tracker jira is mainly for custom agents.
  • [stale-doc] docs/guides/user/adoption.md:101 — "a triage agent that bridges to Jira" is given as an example of a gap the default agents do not cover. The PR now documents default triage handling Jira work items.
    Remediation: Optionally swap in another example; the same line already offers a prioritization agent.
  • [stale-reference] docs/roadmap.md:106 — The current roadmap lists Add JIRA support to the code agent #2265 (code agent Jira support) as an edition focus item, and that issue is closed. This is a dated focus list, so the impact is minor.
    Remediation: Optionally note that Add JIRA support to the code agent #2265 is done and jira-poll: built-in harness files lack CEL triggers, causing 0 dispatches #6672 (triggers) is still open.

@fullsend-ai-review fullsend-ai-review Bot added the requires-manual-review Review requires human judgment label Oct 28, 2026
@codecov

codecov Bot commented Oct 28, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@jwm4

jwm4 commented Oct 30, 2026

Copy link
Copy Markdown
Contributor Author

Closing: #8943 (merged today for #8920) now documents which built-in agents write what to the Jira issue, and makes the claim here that code posts nothing back to Jira out of date (agents#1843). The remaining docs fixes, the stale trigger text in the guide and the note that prioritize has no Jira support yet (#2266), move to #6672, which I have taken.

Written by Bill Murdock with assistance from Claude Code.

@jwm4 jwm4 closed this Oct 30, 2026

This branch was successfully deployed

1 active and 1 inactive deployments
site-preview — 1f322e73 Deployed Oct 28, 2026 by github-actions[bot]
dev — 1f322e73 Deployed Oct 28, 2026 by jwm4 via behaviour #18141
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

requires-manual-review Review requires human judgment risk/moderate PR risk: moderate

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant