Skip to content

docs: add Bitrise for Jira app setup guide - #141

Open
zoltan-baba wants to merge 6 commits into
mainfrom
docs/bitrise-for-jira-app
Open

docs: add Bitrise for Jira app setup guide#141
zoltan-baba wants to merge 6 commits into
mainfrom
docs/bitrise-for-jira-app

Conversation

@zoltan-baba

Copy link
Copy Markdown
Collaborator

Summary

  • Adds a new DevCenter page documenting the Bitrise for Jira app: installing it in Jira, creating a Bitrise API token, connecting projects, verifying the connection, maintaining it, and troubleshooting.
  • Sourced from the RD Confluence draft, rewritten to house style (task-based framing instead of an invented "Bitrise admin" role, gerund procedure headings, Tabs for the two token types).
  • Token permission requirements (Platform Engineer or higher, needed for the outgoing webhook's change_settings and build rerun/abort's run_builds) confirmed against bitrise-website source and product engineering — see TW-1795 for details.

Test plan

  • node scripts/check-links-source.js docs/bitrise-platform/integrations/bitrise-for-jira-app.mdx passes clean
  • Reviewer sanity-check against the live Bitrise for Jira app UI (token creation dialog, config page save flow) before merge

Documents installing the app, creating a Bitrise API token, connecting
projects, verifying the connection, and troubleshooting, based on the
draft from RD Confluence and confirmed permission requirements
(TW-1795).

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@zoltan-baba
zoltan-baba marked this pull request as draft July 23, 2026 15:54
zoltan-baba and others added 2 commits July 23, 2026 18:31
The page belongs alongside other build-status-in-third-party-tool docs
(e.g. Bitrise Checks on GitHub) rather than under Integrations.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
The NT no-translate component only exists on ja-localization-full,
which hasn't merged to main yet, so this branch's build failed with
"Module not found: Can't resolve '@site/src/components/NT'". Strip the
tagging for now; re-add once that branch lands.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown

Requested by Jeremy Palmer (warning added to the Confluence draft on Jul 27): the app supports Jira Cloud only, not self-hosted Jira (Data Center/Server). Placed at the top of the page per his note. The draft's "may introduce this capability in future" line intentionally omitted - docs don't promise roadmap.
Verified against the live UI (Technical Writing workspace, 2026-07-29):
- "Workspace Role" -> "Workspace role" (UI uses lowercase)
- "Configure Access to Products" -> "Configure access to products" (sentence case in UI)
- Dropped "or higher" for the token's Bitrise CI role - the wizard's Role dropdown only offers No access / Platform Engineer / Developer / Tester/QA
- "before closing the dialog" -> "before leaving the Save token step" - token creation is a 3-step wizard, not a dialog

Follow-up filed for the canonical Workspace API token page: TW-1803.
@ilanazholobovsky
ilanazholobovsky marked this pull request as ready for review July 29, 2026 13:54

@ilanazholobovsky ilanazholobovsky left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added Jeremy's Jira Cloud only note + aligned token wording with the live Create token wizard — verified in-product today. Approving.

Replace the TODO placeholder with screenshots of the Bitrise builds
section and the Builds tab of Jira's development panel.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants