Update authorize Bitbucket with Choreo documentation

[RovinKYK]

Description

Bitbucket now requires the use of API Tokens for authorization with Choreo, as App Passwords have been deprecated. The required permissions for Choreo to work with Bitbucket have also changed due to the introduction of new scopes.

Type of change

• Change is only applicable for Developer view
• Change is only applicable for Platform Engineer view
• Change is applicable for both Developer and Platform Engineer views

Testing

• Change is tested in Developer view
• Change is tested in Platform Engineer view

Related issues

https://github.com/wso2-enterprise/choreo/issues/37558

Summary by CodeRabbit

• Documentation
  • Replaced "Personal Access Token"/"PAT" wording with "Credential"/"API token" and updated credential input labels and steps.
  • Updated Bitbucket guidance: renamed account entries to Workspace and added User; reworked permission tables to include a Delete column and rows for Workspace, User, Repositories, Pull Requests, and Webhooks.
  • Clarified per-permission semantics and aligned GitHub/GitLab wording for consistency.

[CLAassistant]

All committers have signed the CLA.

[coderabbitai]

Walkthrough

Documentation updates standardize credential terminology (use "Credential"/"API token" instead of "Personal Access Token"/"PAT"), rename "Account" to "Workspace", add a "User" permission row, and extend Bitbucket permission tables with a Delete column and updated Read/Write/Delete semantics for Workspace, User, Repositories, Pull Requests, and Webhooks.

Changes

Cohort / File(s)

Summary

Bitbucket credential and permissions docs en/developer-docs/docs/develop-components/develop-components-with-git.md, en/pe-docs/docs/infrastructure/credentials/set-up-git-provider-authentication-for-choreo-deployments.md

Replaced "Personal Access Token"/"PAT" wording with "Credential"/"API token"; changed "+Import Credentials" → "+Add Credentials"; updated prompts to request a "Credential". Reworked Bitbucket permissions tables: added a "Delete" column, renamed "Account" → "Workspace", added a "User" row, and adjusted Read/Write/Delete entries for Workspace, User, Repositories, Pull Requests, and Webhooks. Minor wording consistency edits across sections.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Verify consistent replacement of "PAT"/"Personal Access Token" → "API token"/"Credential" across both files.
• Confirm table updates: presence of a "Delete" column, "Workspace" renaming, and added "User" row with correct Read/Write/Delete values.
• Check UI/action text changes (e.g., "+Import Credentials" → "+Add Credentials") and surrounding phrasing.

Poem

🐇 I hop through docs with nimble feet,

Names reborn and tables neat.
Workspace, User take their place,
Delete appears — a tiny trace.
A carrot nod for tidy space.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately reflects the main focus of the changeset: updating Bitbucket authorization documentation for Choreo with new API token requirements and permission changes.
Description check	✅ Passed	The description follows the template with all required sections completed: explains the problem (Bitbucket API Tokens replacing deprecated App Passwords), specifies applicability to both views, confirms testing in both views, and links the related issue.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 97bdc01 and ad3ce5a.

📒 Files selected for processing (1)

• en/pe-docs/docs/infrastructure/credentials/set-up-git-provider-authentication-for-choreo-deployments.md (2 hunks)

🔇 Additional comments (4)

en/pe-docs/docs/infrastructure/credentials/set-up-git-provider-authentication-for-choreo-deployments.md (4)

12-12: ✓ GitHub capitalization corrected.

Line 12 now correctly uses "GitHub" consistently throughout. This resolves the previous review comment.

---

17-18: Verify credential naming clarity for users.

Line 18 now uses the generic term "Credential" instead of "Personal Access Token." While this aligns with Choreo's internal terminology (where a Credential comprises multiple fields), users following this step may find it unclear what credential to enter—especially since the preceding line mentions "API tokens for Bitbucket, Personal access tokens for GitLab."

Consider clarifying the instruction to help users understand they should enter the Git provider token they obtained:

-6. Enter a **Credential Name**, select the Git provider, and enter the **Credential** you obtained from the Git provider.
+6. Enter a **Credential Name**, select the Git provider, and enter the **Credential** (API token for Bitbucket, personal access token for GitLab) you obtained from the Git provider.

Alternatively, if Choreo's UI already labels this field clearly, this may not require a change.

---

36-36: ✓ Grammar correction applied.

Line 36 correctly changes "a API token" to "an API token" to match the vowel sound. This resolves the previous review comment.

---

38-44: ✓ Bitbucket permissions table restructured appropriately.

The updated permissions table for Bitbucket now includes:

• Delete column to reflect new permission scopes
• Workspace and User rows with appropriate read-only permissions (Y/N/N)
• Consistent permission mapping for Repositories, Pull Requests, and Webhooks

The structure aligns with the API token documentation requirements and the statement that these permissions enable Choreo to perform actions on behalf of users.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (2)

en/pe-docs/docs/infrastructure/credentials/set-up-git-provider-authentication-for-choreo-deployments.md (1)

12-12: Clarify generic credential instruction for different Git providers.

Line 12 states users should connect Bitbucket and GitLab repositories using a "Personal Access Token (PAT)," but the Bitbucket section now specifies API tokens. Consider clarifying that different providers use different token types (Bitbucket now requires API tokens, GitLab uses PAT).

Example revision:

-You can connect Bitbucket, Gitlab repositories to choreo organization using a Personal Access Token(PAT). For github, the developers can install  [WSO2 Cloud App](https://github.com/marketplace/choreo-apps) during component creation and get necessary permissions via Github itself.
+You can connect Bitbucket and GitLab repositories to your Choreo organization using credential tokens (API tokens for Bitbucket, personal access tokens for GitLab). For GitHub, developers can install the [WSO2 Cloud App](https://github.com/marketplace/choreo-apps) during component creation to grant necessary permissions.

en/developer-docs/docs/develop-components/develop-components-with-git.md (1)

22-22: Clarify generic credential instruction for different Git providers.

Line 22 instructs users to enter a "Personal Access Token" generically for all providers, but the Bitbucket section specifies API tokens. Consider clarifying that different providers use different token types (Bitbucket now requires API tokens, GitLab uses PAT).

Example revision:

-6. Enter a **Credential Name**, select the Git provider, and enter the **Personal Access Token** you obtained from the Git provider.
+6. Enter a **Credential Name**, select the Git provider, and enter the credential token (API token for Bitbucket, personal access token for GitLab) you obtained from the Git provider.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7f38f97 and 4099792.

📒 Files selected for processing (2)

• en/developer-docs/docs/develop-components/develop-components-with-git.md (1 hunks)
• en/pe-docs/docs/infrastructure/credentials/set-up-git-provider-authentication-for-choreo-deployments.md (1 hunks)

🔇 Additional comments (2)

en/pe-docs/docs/infrastructure/credentials/set-up-git-provider-authentication-for-choreo-deployments.md (1)

36-44: Content update is accurate and consistent with Bitbucket API token requirements.

The permissions table correctly reflects the API token-based authentication model. The addition of the Delete column for Webhooks aligns with the new scopes available in Bitbucket API tokens.

en/developer-docs/docs/develop-components/develop-components-with-git.md (1)

91-99: Content update is accurate and consistent with Bitbucket API token requirements.

The permissions table correctly reflects the API token-based authentication model. The addition of the Delete column for Webhooks aligns with the new scopes available in Bitbucket API tokens. The changes are identical and consistent with the PE documentation file.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7cec60d and 15f3693.

📒 Files selected for processing (2)

• en/developer-docs/docs/develop-components/develop-components-with-git.md (2 hunks)
• en/pe-docs/docs/infrastructure/credentials/set-up-git-provider-authentication-for-choreo-deployments.md (2 hunks)

🧰 Additional context used

🪛 LanguageTool

en/pe-docs/docs/infrastructure/credentials/set-up-git-provider-authentication-for-choreo-deployments.md

[uncategorized] ~12-~12: The official name of this software platform is spelled with a capital “H”.
Context: ...Personal access tokens for GitLab). For github, the developers can install [WSO2 Clou...

(GITHUB)

---

[uncategorized] ~12-~12: The official name of this software platform is spelled with a capital “H”.
Context: ...ation and get necessary permissions via Github itself. 1. Sign in to the [Choreo Cons...

(GITHUB)

🔇 Additional comments (4)

en/developer-docs/docs/develop-components/develop-components-with-git.md (2)

22-22: ✓ Approved: Terminology update from "Personal Access Token" to "Credential"

The updated terminology is clearer and aligns with the Choreo UI conventions. This change provides better consistency across the documentation.

---

91-99: ✓ Approved: Bitbucket permissions table with API token terminology and Delete column

The table structure is correct, includes the previously-flagged grammar fix ("an API token"), and reflects the updated permission model with Workspace, User, and Delete semantics. The permissions align with Bitbucket's current API token capabilities.

en/pe-docs/docs/infrastructure/credentials/set-up-git-provider-authentication-for-choreo-deployments.md (2)

17-18: ✓ Approved: Credential terminology and flow steps

The updated terminology ("Credential Name", "Credential Token") is clearer than the prior wording. Combined with the context provided in line 12, users can now distinguish between different credential types (API tokens vs. Personal access tokens) across Git providers.

---

36-44: ✓ Approved: Bitbucket permissions table consistent with developer documentation

The permission table correctly reflects the updated API token model with the Delete column and new entities (Workspace, User). Permissions are consistently defined across both documentation files.