Repository navigation
docs(#4885): document Jira auth model, token rotation, migration - #8678
fullsend-ai-coder[bot] wants to merge 3 commits into
Conversation
The Jira guide called the poller identity a "service account" without
saying which kind, gave only a one-line rotation tip, and did not say
how fullsend could move off long-lived API tokens.
Add to docs/guides/user/jira-integration.md:
- Authentication model: the current contract (HTTP Basic with
JIRA_USER_EMAIL + JIRA_TOKEN against <site>/rest/api/3, checked
against internal/forge/jira/client.go and the poll, tracker and
run-status callers), the recommended dedicated non-human account, and
Atlassian-managed service accounts (scoped tokens, OAuth 2.0 client
credentials via api.atlassian.com/ex/jira/{cloudId}), which fullsend
does not support yet. Includes a data-exposure note linking #2513.
- Rotating the Jira API token: where copies live (per-repo secrets, the
pre-encoded atlassian-cloud sandbox credential), a zero-downtime
procedure, and leak handling.
- Migration path: OAuth client credentials as the target, why it is not
workload-identity federation, and the code work it needs (auth
abstraction, cloudId config, sandbox egress, revalidating each Jira
operation fullsend performs).
Also replace the ambiguous "service account" wording in the setup
overview, prerequisites and bot-filtering paragraph, and point the 401
troubleshooting row at the rotation section.
Atlassian service-account details come from Atlassian's documentation
as cited in the issue; the sandbox had no network access to re-check
them.
Note: pre-commit could not fetch remote hook repos (TLS failure in the
sandbox). The applicable hooks were run directly instead: whitespace,
EOF, line-ending and merge-marker checks, lint-docs-links,
lint-broken-symlinks, lychee --offline --include-fragments, and
gitleaks via scan-secrets. All passed.
Closes #4885
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
🤖 Finished Review · ✅ Success · Started 8:09 PM UTC · Completed 8:18 PM UTC Commit: Runtime: pi · Model: sonnet → claude-sonnet-5-5 · Effort: high · Cost: $1.73 |
Site previewPreview: https://01370ae9-site.fullsend-ai.workers.dev Commit: |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
|
<!-- fullsend:risk-assessment --> DetailsDocumentation-only update by a bot aligning with issue #4885, elevated to moderate risk by git history showing recent churn (8 commits in 30 days) and high change coupling. Previous run<!-- fullsend:risk-assessment --> DetailsDocumentation-only update by a bot aligning with issue #4885, elevated to moderate risk by git history showing recent churn (8 commits in 30 days) and high change coupling. Previous run (2)<!-- fullsend:risk-assessment --> DetailsDocumentation-only update by a bot aligning with issue #4885, elevated to moderate risk by git history showing recent churn (8 commits in 30 days) and high change coupling. |
|
Looks good to me Earlier findings
Previous run<!-- fullsend:review-findings-v2:eyJ2ZXJzaW9uIjoyLCJhY3Rpb24iOiJyZXF1ZXN0LWNoYW5nZXMiLCJmaW5kaW5ncyI6W3sic2V2ZXJpdHkiOiJtZWRpdW0iLCJjYXRlZ29yeSI6ImFwaS1jb250cmFjdCIsImZpbGUiOiJkb2NzL2d1aWRlcy91c2VyL2ppcmEtaW50ZWdyYXRpb24ubWQiLCJpZCI6ImZfMTEzNTU4ZDEyZWZkNTkzMiIsImxpbmUiOjIwMiwiYWN0aW9uYWJsZSI6dHJ1ZX0seyJzZXZlcml0eSI6ImxvdyIsImNhdGVnb3J5Ijoic2VjcmV0LWV4cG9zdXJlIiwiZmlsZSI6ImRvY3MvZ3VpZGVzL3VzZXIvamlyYS1pbnRlZ3JhdGlvbi5tZCIsImlkIjoiZl8xNjVlMWViZDgzMjRiYTQ5IiwibGluZSI6MjAyLCJhY3Rpb25hYmxlIjp0cnVlfV0sImRpc3Bvc2l0aW9ucyI6W3siaWQiOiJmXzE2NWUxZWJkODMyNGJhNDkiLCJzdGF0dXMiOiJyZXNvbHZlZF9ieV9jaGFuZ2UifV19 --> ReviewFindingsMedium
Earlier findings
Next steps:
Previous run (2)<!-- fullsend:review-findings-v2:eyJ2ZXJzaW9uIjoyLCJhY3Rpb24iOiJyZXF1ZXN0LWNoYW5nZXMiLCJmaW5kaW5ncyI6W3sic2V2ZXJpdHkiOiJsb3ciLCJjYXRlZ29yeSI6InNlY3JldC1leHBvc3VyZSIsImZpbGUiOiJkb2NzL2d1aWRlcy91c2VyL2ppcmEtaW50ZWdyYXRpb24ubWQiLCJpZCI6ImZfMTY1ZTFlYmQ4MzI0YmE0OSIsImxpbmUiOjIwMiwiYWN0aW9uYWJsZSI6dHJ1ZX1dfQ== --> ReviewFindingsLow
Labels: PR modifies user-facing documentation only Next steps:
|
|
🤖 Finished Fix · ✅ Success · Started 8:20 PM UTC · Completed 8:23 PM UTC Commit: Runtime: claude · Model: sonnet → claude-sonnet-5-5 · Effort: high · Cost: $0.21 |
Warn in the token rotation steps that the base64-encoded credential is a secret and should not be left in terminal scrollback or logs; recommend piping it straight into the secret store's stdin input. Note: pre-commit could not run (hook repositories not fetchable in the sandbox). Checked trailing whitespace via git diff --check, ran the secret scan, and ran lychee offline link check on the file. Addresses #8678 Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
🔧 Fix agent — iteration 1 (bot-triggered)Addressed the single low-severity review finding by adding a secret-handling warning to rotation step 4 of the Jira integration guide. Fixed (1):
Tests: passed CI inspections (4):
Conflict update: skipped; strategy
|
|
🤖 Finished Review · ✅ Success · Started 8:25 PM UTC · Completed 8:34 PM UTC Commit: Runtime: pi · Model: sonnet → claude-sonnet-5-5 · Effort: high · Cost: $1.40 |
|
🤖 Finished Fix · ✅ Success · Started 8:36 PM UTC · Completed 8:39 PM UTC Commit: Runtime: claude · Model: sonnet → claude-sonnet-5-5 · Effort: high · Cost: $0.22 |
Strip line wraps from the base64-encoded Jira credential examples so the stored value is a single line (GNU base64 wraps at 76 characters). Note: pre-commit could not fetch remote hook repositories; ran the applicable hooks directly (whitespace, docs link scope, markdown links, broken symlinks), all passing. No tests apply to this docs-only change. Addresses #8678 Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
🔧 Fix agent — iteration 2 (bot-triggered)Fixed the one open finding: both base64 credential examples now strip line wraps so the stored value is single-line. The earlier secret-exposure finding was already resolved. Fixed (1):
Tests: passed CI inspections (4):
Conflict update: skipped; strategy
|
|
🤖 Finished Review · ✅ Success · Started 8:41 PM UTC · Completed 8:48 PM UTC Commit: Runtime: pi · Model: sonnet → claude-sonnet-5-5 · Effort: high · Cost: $1.00 |
Superseded by updated review
Superseded by updated review
Summary
Updates
docs/guides/user/jira-integration.mdwith the parts of #4885 that were still missing:Related Issue
#4885. The data-leakage assessment is still tracked in #2513, which the new docs link to.
Changes
JIRA_USER_EMAIL+JIRA_TOKENagainst<JIRA_BASE_URL>/rest/api/3, with/myselfused for bot self-filtering. Checked againstinternal/forge/jira/client.goand its callers (internal/cli/poll.go,jira_tracker.go,tracker_client.go), which all require an email.api.atlassian.com/ex/jira/{cloudId}. Fullsend doesn't support these yet (nocloudId, URLs built from the site URL, sandbox egress limited to*.atlassian.net).JIRA_TOKENsecret, the pre-encodedatlassian-cloudsandbox credential, and local shells./myselfbefore deploying it.Testing
make lint(pre-commit run) could not fetch remote hook repos in the sandbox (TLS failure). The hooks that apply to Markdown were run directly and passed: trailing-whitespace, end-of-file, mixed-line-ending and merge-conflict checks,hack/lint-docs-links,hack/lint-broken-symlinks,lychee --offline --include-fragments(all new anchors resolve), and gitleaks viascan-secrets.Caveat: the statements about Atlassian service accounts (gateway URL, OAuth token exchange, short-lived Bearer tokens) follow Atlassian's documentation as cited in the issue thread. The sandbox had no network access to re-check them, so a reviewer may want to compare them against the linked Atlassian pages.
Checklist
!for breaking changes)🤖 Generated with Claude Code
Closes #4885
Post-script verification
agent/4885-jira-auth-strategy-docs)3a098356a46d2367a73eef876294981d57d15455..HEAD)