Update authorize Bitbucket with Choreo documentation #1877
Conversation
|
|
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. WalkthroughStandardized credential terminology and UI text: "Personal Access Token"/"PAT" → "Credential"/"API token"; "+Import Credentials" → "+Add Credentials"; Bitbucket permission tables updated — "Account" → "Workspace", added "User" row, and a "Delete" column with adjusted Read/Write/Delete entries. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
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
📒 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.
en/developer-docs/docs/develop-components/develop-components-with-git.md
Outdated
Show resolved
Hide resolved
...docs/infrastructure/credentials/set-up-git-provider-authentication-for-choreo-deployments.md
Outdated
Show resolved
Hide resolved
en/developer-docs/docs/develop-components/develop-components-with-git.md
Outdated
Show resolved
Hide resolved
...docs/infrastructure/credentials/set-up-git-provider-authentication-for-choreo-deployments.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 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 columnThe 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 stepsThe 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 documentationThe 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.
...docs/infrastructure/credentials/set-up-git-provider-authentication-for-choreo-deployments.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Pull request overview
This PR updates the Bitbucket authorization documentation to reflect the deprecation of App Passwords in favor of API Tokens. The documentation changes clarify credential terminology and update the required permissions table to reflect Bitbucket's new scope structure.
- Replaced "Personal Access Token" / "PAT" terminology with "Credential" / "API token" throughout the documentation
- Updated Bitbucket permission table to include a "Delete" column and new granular scopes (Workspace, User instead of Account)
- Standardized formatting and wording consistency across all Git provider sections
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| en/pe-docs/docs/infrastructure/credentials/set-up-git-provider-authentication-for-choreo-deployments.md | Updated credential terminology, modified Bitbucket permissions table with new scopes, and improved formatting consistency |
| en/developer-docs/docs/develop-components/develop-components-with-git.md | Applied the same credential terminology and Bitbucket permission table updates to developer-facing documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
...docs/infrastructure/credentials/set-up-git-provider-authentication-for-choreo-deployments.md
Outdated
Show resolved
Hide resolved
...docs/infrastructure/credentials/set-up-git-provider-authentication-for-choreo-deployments.md
Show resolved
Hide resolved
…-authentication-for-choreo-deployments.md Co-authored-by: Copilot <[email protected]>
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
en/pe-docs/docs/infrastructure/credentials/set-up-git-provider-authentication-for-choreo-deployments.md
🔇 Additional comments (2)
en/pe-docs/docs/infrastructure/credentials/set-up-git-provider-authentication-for-choreo-deployments.md (2)
35-43: Bitbucket permissions table correctly updated to reflect API Token requirement.The table now properly reflects the API Token model with the new
Deletecolumn andWorkspace/Userrows, aligning with Bitbucket's updated scopes and the PR objective documenting that App Passwords have been deprecated. All grammar corrections from prior reviews have been applied (e.g., "an API token").Please verify that these Bitbucket API Token scopes and the Delete semantics match the current Bitbucket API documentation, as the scopes may have evolved since your implementation.
15-19: Step numbering and UI terminology correctly updated.Steps are now properly sequential (1–6), and the UI text "+Add Credentials" with generic "Credential" terminology is consistent with the revised credential flow. All issues flagged in prior reviews have been resolved.
...docs/infrastructure/credentials/set-up-git-provider-authentication-for-choreo-deployments.md
Outdated
Show resolved
Hide resolved
…-authentication-for-choreo-deployments.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
en/pe-docs/docs/infrastructure/credentials/set-up-git-provider-authentication-for-choreo-deployments.md (2)
8-8: Standardize product name capitalization: "choreo-console" → "Choreo Console".For consistency with line 15 which references "Choreo Console", update this occurrence to match the standardized product name formatting.
🔎 Proposed fix
-In Choreo, you can connect a Git repository that contains some source code or a Docker project. Once you connect your Git repository to Choreo, you can build, deploy, and manage your application easily with choreo-console. +In Choreo, you can connect a Git repository that contains some source code or a Docker project. Once you connect your Git repository to Choreo, you can build, deploy, and manage your application easily with Choreo Console.
47-47: Align terminology with document standardization: update "personal access token (PAT)" to "API token" for consistency.The document now standardizes on "Credential" and "API token" terminology (lines 12, 18, 35), but the GitLab section (line 47) and Azure DevOps section (line 55) still reference "personal access token (PAT)" and "Personal Access Token (PAT)". For coherence across the documentation, consider updating these to match the new standardized terminology.
🔎 Proposed fixes
GitLab (line 47):
-Authorizing using a personal access token (PAT) obtained from your GitLab self-managed server grants Choreo the following permissions to perform the respective actions on your behalf within the repository. +Authorizing using an API token obtained from your GitLab self-managed server grants Choreo the following permissions to perform the respective actions on your behalf within the repository.Azure DevOps (line 55):
-Authorizing Choreo using a Personal Access Token (PAT) from Azure DevOps grants Choreo the following permissions to perform actions on your behalf within the selected organization and project. +Authorizing Choreo using an API token from Azure DevOps grants Choreo the following permissions to perform actions on your behalf within the selected organization and project.Also applies to: 55-55
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
en/pe-docs/docs/infrastructure/credentials/set-up-git-provider-authentication-for-choreo-deployments.md
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
en/pe-docs/docs/infrastructure/credentials/set-up-git-provider-authentication-for-choreo-deployments.md (1)
8-8: Capitalize product reference: "choreo-console" → "Choreo Console".For consistency with product naming conventions used elsewhere in the document (e.g., "Choreo Console" on line 15, "Choreo platform" on line 3), this reference should be capitalized.
🔎 Proposed fix
-In Choreo, you can connect a Git repository that contains some source code or a Docker project. Once you connect your Git repository to Choreo, you can build, deploy, and manage your application easily with choreo-console. +In Choreo, you can connect a Git repository that contains some source code or a Docker project. Once you connect your Git repository to Choreo, you can build, deploy, and manage your application easily with the Choreo Console.
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
en/pe-docs/docs/infrastructure/credentials/set-up-git-provider-authentication-for-choreo-deployments.md
🔇 Additional comments (3)
en/pe-docs/docs/infrastructure/credentials/set-up-git-provider-authentication-for-choreo-deployments.md (3)
15-19: Steps are well-structured with updated terminology.The step instructions correctly implement the terminology changes ("+Add Credentials" and "Credential" as generic term) and the step numbering is now correct.
35-43: Bitbucket authorization section is well-updated.The terminology change to "API token" (with corrected grammar), the permission table restructuring with Workspace/User rows, and the addition of the Delete column are all appropriate for the updated Bitbucket authentication model.
47-47: Verify terminology consistency across provider sections.The Bitbucket section now uses "API token" terminology, while GitLab (line 47) and Azure DevOps (line 55) sections still reference "personal access token (PAT)". While this may be intentional (as these providers use different token names), verify that the terminology is consistent with product naming conventions and documentation standards.
Also applies to: 55-55
3 participants
Description
Type of change
Testing
Related issues
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.