Repository navigation
docs(#6847): add a setup overview to the Jira integration guide - #7691
Conversation
The Jira guide jumped into polling internals before operators could see the end-to-end setup. Add a six-step overview at the top covering the service account, dual project roles, GitHub install, poller workflow, project/JQL, and per-agent trigger expressions. Call out that one account holding both Developers and Administrators is more power than we want long-term, and that the trigger step is temporary until built-in harnesses ship native Jira triggers (#6672). Align Prerequisites and Repo configuration with that picture so they do not contradict the overview. Note: pre-commit could not fetch remote hook repos (HTTP 403). Ran equivalent local checks instead: trailing-whitespace, end-of-file, lint-docs-links, lychee, gitleaks, and scan-secrets. Closes #6847
|
🤖 Finished Review · ✅ Success · Started 7:32 PM UTC · Completed 7:46 PM UTC Commit: Runtime: pi · Model: sonnet → claude-sonnet-5 · Effort: high · Cost: $4.05 |
Site previewPreview: https://5fd37c65-site.fullsend-ai.workers.dev Commit: |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
|
Risk Assessment: moderate (2/5) DetailsLow-risk additive documentation change directly addressing the linked issue (Tier 1 = 1.00, Tier 3 = 1.33); historical git churn and regression-fix frequency on this guide keep Tier 2 at 2.86, producing a composite of 1.62 that rounds to 2 (moderate), unchanged from the prior review of this PR. Previous runRisk Assessment: moderate (2/5) DetailsLow-risk additive documentation change directly addressing the linked issue and its own prior review finding (Tier 1 = 1.0, Tier 3 = 1.33); historical git churn/regression-fix frequency on this guide keeps Tier 2 at 2.86, producing a composite of 1.63 that rounds to 2 (moderate), unchanged from the prior review of this PR. Previous run (2)Risk Assessment: moderate (2/5) DetailsLow-risk additive documentation change directly addressing the linked issue (Tier 1 = 1.0, Tier 3 = 1.33), but historical git churn and regression-fix frequency on this guide elevate Tier 2 to 2.86, producing a composite of 1.63 that rounds to 2 (moderate). |
|
Looks good to me Previous runLooks good to me Previous run (2)ReviewFindingsMedium
Next steps:
|
|
🤖 Finished Fix · ✅ Success · Started 7:48 PM UTC · Completed 7:53 PM UTC Commit: Runtime: claude · Model: sonnet → claude-sonnet-5 · Effort: high · Cost: $0.81 |
…sions Reviewer flagged that "add the trigger expressions from step 6" reads as "put trigger: in config.yaml", but AgentEntry has no Trigger field and config.yaml is decoded without strict/KnownFields mode, so the key would silently be dropped. trigger belongs on a Harness YAML file registered via config.yaml's agents[].source. Reword step 6 and the Repo configuration paragraph to say so explicitly and link the base: composition section. Addresses #7691
🔧 Fix agent — iteration 1 (bot-triggered)Confirmed the single medium-severity finding against internal/config/config.go and internal/harness/harness.go, then reworded the two affected passages in the Jira integration guide to name the harness file explicitly instead of implying config.yaml, matching the reviewer's remediation. Fixed (1):
Tests: passed CI inspections (12):
Next steps:
|
|
🤖 Finished Review · ✅ Success · Started 7:55 PM UTC · Completed 8:05 PM UTC Commit: Runtime: pi · Model: sonnet → claude-sonnet-5 · Effort: high · Cost: $2.33 |
Superseded by updated review
Signed-off-by: Ralph Bean <rbean@redhat.com>
|
🤖 Finished Review · ✅ Success · Started 8:48 PM UTC · Completed 8:59 PM UTC Commit: Runtime: pi · Model: sonnet → claude-sonnet-5 · Effort: high · Cost: $2.58 |
Superseded by updated review
|
🤖 Finished Retro · ✅ Success · Started 8:37 PM UTC · Completed 8:45 PM UTC Commit: Runtime: claude · Model: sonnet → claude-sonnet-5 · Effort: high · Cost: $1.42 |
|
PR #7691 (docs-only, six-step Jira setup overview) is a healthy example of the pipeline working as intended. The first review pass correctly flagged a real medium-severity logic error (the doc implied I checked whether this is a recurring pattern: a full-history search of |
Summary
Add a six-step setup overview at the top of the Jira integration guide so operators can see the whole path before diving into polling internals.
Related Issue
#6847 (setup TL;DR). Sibling #6846 still tracks trimming the implementation-heavy sections of the same guide.
Changes
triggerexpressions.Testing
hack/lint-docs-linksandlychee --offline --include-fragmentson the edited guide (0 errors).scan-secrets) and gitleaks on the edited file.make lint—pre-commit runcould not fetch remote hook repos (HTTP 403). Equivalent local markdown hooks were run instead.Checklist
Closes #6847
Post-script verification
agent/6847-jira-setup-overview)3871d1b17c2a81f763156ab97b89c4c90d80acf3..HEAD)