Skip to content

docs(jira): align setup guide with implemented behavior (#552) - #554

Merged
krokoko merged 1 commit into
aws-samples:mainfrom
ayushtr-aws:docs/552-jira-setup-guide-fixes
Jul 8, 2026
Merged

krokoko merged 1 commit into
aws-samples:mainfrom
ayushtr-aws:docs/552-jira-setup-guide-fixes

Conversation

@ayushtr-aws

Copy link
Copy Markdown
Contributor

Closes #552.

Docs-only. Aligns docs/guides/JIRA_SETUP_GUIDE.md with what a live setup walkthrough of the integration actually requires (dev-stack deployment, 2026-07-07/08). No behavior described here is new — the guide now matches the code as shipped.

Changes

  • Prerequisites — state the stack must be deployed at a version including the Jira integration (feat(jira): Jira Cloud integration -- parity with Linear (#288) #302); pre-feat(jira): Jira Cloud integration -- parity with Linear (#288) #302 stacks have no Jira resources and need a sync + redeploy first.
  • Step 2 (OAuth) — new note for the "Waiting for browser callback…" stall (wrong browser profile, closed consent tab, port 8080 conflict) and that Ctrl-C + re-run is safe/idempotent. Mirrored as a Troubleshooting entry.
  • Step 4 (map) — point at setup's ready-to-paste "Next steps" map command; document cloudId recovery (https://<site>.atlassian.net/_edge/tenant_info or the workspace registry) since it's not in the Jira UI.
  • Step 5 (identity linking) — the guide said "populate the user-mapping row manually" without schema or command. Now includes the exact aws dynamodb put-item with the row shape jira-link.ts writes (jira_identity = <cloudId>#<accountId>, platform_user_id, linked_at, status: active, link_method), how to find the Atlassian accountId and Cognito sub, a cross-link to CLI: implement bgagent jira invite-user — issuing half of Jira identity linking #553 (bgagent jira invite-user), and a note that the processor's "Run bgagent jira link <code>" comment is a dead end until CLI: implement bgagent jira invite-user — issuing half of Jira identity linking #553 lands.
  • Troubleshooting — new "401 when calling the Jira API directly after setup" entry: the ~1 h token life is expected, refresh happens Lambda-side on the next webhook, and manual refresh is hazardous (Atlassian rotates the refresh token per use; the write-back must preserve webhook_signing_secret).
  • DiagramPOST /jira/webhookPOST /v1/jira/webhook (API GW stage prefix).

Deliberately not touched: the map-time repo-onboarding prerequisite — #374 (fix for #369) adds that line; avoiding a conflict.

Verification

  • mise run build green (includes //docs:sync mirror regeneration + docs link-check); the Starlight mirror docs/src/content/docs/using/Jira-setup-guide.md is regenerated in the same commit.
  • The Step-5 put-item shape was validated against a live deployment: a manually-written row with exactly these fields attributes label-triggered tasks correctly (verified via bgagent list and the processor logs).

)

Fixes from a live setup walkthrough on a dev stack:

- Prerequisites: state the stack must include the Jira integration
  (aws-samples#302) — pre-aws-samples#302 stacks have no Jira resources and need a redeploy
- Step 2: note on the stalled 'Waiting for browser callback' state and
  that re-running setup is safe/idempotent (+ troubleshooting entry)
- Step 4: point at setup's ready-to-paste Next-steps map command; add
  cloudId recovery via _edge/tenant_info or the workspace registry
- Step 5: document the interim manual user-mapping put-item with the
  exact row shape jira-link.ts writes, how to find the Atlassian
  accountId and Cognito sub, and cross-link aws-samples#553 (invite-user); call
  out the dead-end 'run jira link' comment for unlinked users
- Troubleshooting: new '401 calling the API right after setup' entry —
  ~1h token life, Lambda-side refresh on next webhook, manual-refresh
  hazards (refresh-token rotation, webhook_signing_secret preservation)
- Diagram: POST /jira/webhook → POST /v1/jira/webhook (stage prefix)

Starlight mirror regenerated via mise //docs:sync.
@ayushtr-aws
ayushtr-aws requested review from a team as code owners July 8, 2026 18:56
@krokoko
krokoko enabled auto-merge July 8, 2026 19:04
@codecov-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@6340aba). Learn more about missing BASE report.
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #554   +/-   ##
=======================================
  Coverage        ?   88.88%           
=======================================
  Files           ?      222           
  Lines           ?    52551           
  Branches        ?     5199           
=======================================
  Hits            ?    46709           
  Misses          ?     5842           
  Partials        ?        0           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@krokoko
krokoko added this pull request to the merge queue Jul 8, 2026
Merged via the queue into aws-samples:main with commit 9467a94 Jul 8, 2026
4 checks passed
isadeks pushed a commit to isadeks/sample-autonomous-cloud-coding-agents that referenced this pull request Jul 28, 2026
) (aws-samples#554)

Fixes from a live setup walkthrough on a dev stack:

- Prerequisites: state the stack must include the Jira integration
  (aws-samples#302) — pre-aws-samples#302 stacks have no Jira resources and need a redeploy
- Step 2: note on the stalled 'Waiting for browser callback' state and
  that re-running setup is safe/idempotent (+ troubleshooting entry)
- Step 4: point at setup's ready-to-paste Next-steps map command; add
  cloudId recovery via _edge/tenant_info or the workspace registry
- Step 5: document the interim manual user-mapping put-item with the
  exact row shape jira-link.ts writes, how to find the Atlassian
  accountId and Cognito sub, and cross-link aws-samples#553 (invite-user); call
  out the dead-end 'run jira link' comment for unlinked users
- Troubleshooting: new '401 calling the API right after setup' entry —
  ~1h token life, Lambda-side refresh on next webhook, manual-refresh
  hazards (refresh-token rotation, webhook_signing_secret preservation)
- Diagram: POST /jira/webhook → POST /v1/jira/webhook (stage prefix)

Starlight mirror regenerated via mise //docs:sync.
@scottschreckengaust scottschreckengaust added the v1 Version 1 label Sep 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

v1 Version 1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: Jira setup guide — align with implemented behavior (identity linking, OAuth callback, token expiry, prereqs)

4 participants