docs(jira): align setup guide with implemented behavior (#552)#554
Merged
krokoko merged 1 commit intoJul 8, 2026
Merged
Conversation
) 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.
krokoko
approved these changes
Jul 8, 2026
|
Codecov Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #552.
Docs-only. Aligns
docs/guides/JIRA_SETUP_GUIDE.mdwith 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
setup's ready-to-paste "Next steps"mapcommand; document cloudId recovery (https://<site>.atlassian.net/_edge/tenant_infoor the workspace registry) since it's not in the Jira UI.aws dynamodb put-itemwith the row shapejira-link.tswrites (jira_identity = <cloudId>#<accountId>,platform_user_id,linked_at,status: active,link_method), how to find the AtlassianaccountIdand Cognito sub, a cross-link to CLI: implementbgagent jira invite-user— issuing half of Jira identity linking #553 (bgagent jira invite-user), and a note that the processor's "Runbgagent jira link <code>" comment is a dead end until CLI: implementbgagent jira invite-user— issuing half of Jira identity linking #553 lands.webhook_signing_secret).POST /jira/webhook→POST /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 buildgreen (includes//docs:syncmirror regeneration + docs link-check); the Starlight mirrordocs/src/content/docs/using/Jira-setup-guide.mdis regenerated in the same commit.bgagent listand the processor logs).