Update Bitbucket docs with latest api token changes #426
Conversation
|
Caution Review failedFailed to post review comments. Configuration used: CodeRabbit UI 📒 Files selected for processing (1)
🧰 Additional context used🧠 Learnings (1)docs/platforms/bitbucket-cloud.md (2)🪛 LanguageTooldocs/platforms/bitbucket-cloud.md[style] ~45-~45: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE) [typographical] ~137-~137: It seems that a comma is missing. (IF_PLEASE_COMMA) [style] ~137-~137: Try using a more formal synonym for ‘check’. (VERIFY) 🔇 Additional comments (1)
WalkthroughThe documentation for Bitbucket Cloud integration was updated to replace all mentions of "App Password" with "API Token." Instructions, navigation steps, permission scopes, images, and troubleshooting sections were revised to reflect the current API token creation and usage process. No code or logic changes were made. Changes
Poem
✨ Finishing Touches🧪 Generate Unit Tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (6)
docs/platforms/bitbucket-cloud.md (6)
16-18: Standardize “API token” capitalizationThe section header and the first sentence mix “Api”/“api” with “API”. For consistency with industry terminology and the rest of our docs, use “API token” (all-caps “API”, lower-case “token”).
-## Configure Api Token +## Configure API Token -To enable CodeRabbit to interact with your Bitbucket repositories, an api token is required. +To enable CodeRabbit to interact with your Bitbucket repositories, an API token is required.
23-30: Fix mixed capitalisation & minor wordingMultiple occurrences still use “Api token / api token”. Align them with “API token”. While you’re here, tighten the wording slightly.
-4. Generate an Api Token to enable seamless integration between CodeRabbit and your Bitbucket repositories. +4. Generate an API token to enable seamless integration between CodeRabbit and your Bitbucket repositories. -We recommend creating a new user as a service account, associating this user to the workspace you'd like to install CodeRabbit on, and providing CodeRabbit with the api token to allow access. +We recommend creating a new user as a service account, associating this user with the workspace you'd like to install CodeRabbit on, and providing CodeRabbit with the API token to allow access. -If you wish to change the review user, you must provide the api token for the new user who will post reviews and comments. +If you wish to change the review user, you must provide the API token for the new user who will post reviews and comments.
43-47: Heading & body: keep “API token” consistentThe heading says “Api token”, while the paragraph below mixes cases again. Suggest:
-#### Generating an Api token +#### Generating an API token -Bitbucket provides an option to generate an api token for a new user. +Bitbucket lets you generate an API token for a new user.
55-68: Replace hard tabs with spaces to satisfy markdownlint (MD010)The nested-numbered list is indented with tab characters, triggering MD010 warnings. Convert the tabs to four spaces (or two—pick one house style) so CI passes.
Example for the first few lines:
- 1. read:account - 2. read:user:bitbucket + 1. read:account + 2. read:user:bitbucket
70-82: Last lingering “Api / api token” instancesTwo more occurrences need the same update:
-8. Note down the api token as it will only be displayed once. +8. Note down the API token as it will only be displayed once. -### Where to Provide CodeRabbit the Api Token +### Where to Provide CodeRabbit the API Token -By default, if no api token is provided, CodeRabbit will prompt you to provide one … +By default, if no API token is provided, CodeRabbit will prompt you to provide one …
120-120: Add comma & use “verify” for a more formal tone-If you cannot install the webhook please check that your Bitbucket user has the necessary permissions to install the webhook and the Api Token is properly configured. +If you cannot install the webhook, please verify that your Bitbucket user has the necessary permissions and that the API token is properly configured.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
static/img/integrations/bitbucket-api-token-scopes.pngis excluded by!**/*.png,!**/*.png
📒 Files selected for processing (1)
docs/platforms/bitbucket-cloud.md(3 hunks)
🧰 Additional context used
🧠 Learnings (1)
docs/platforms/bitbucket-cloud.md (2)
Learnt from: aravindputrevu
PR: coderabbitai/coderabbit-docs#402
File: docs/guides/setup-best-practices.md:21-21
Timestamp: 2025-06-18T09:22:07.198Z
Learning: The word "CodeRabbit" should always have both C and R capitalized (not "coderabbit", "Coderabbit", or "CoderabbitAI"). The correct format is "CodeRabbit" and "CodeRabbitAI" for the service account. Proactively correct this capitalization in review comments when contributors mistype it.
Learnt from: aravindputrevu
PR: coderabbitai/coderabbit-docs#121
File: docs/guides/delete-account.md:46-47
Timestamp: 2024-10-31T16:33:25.070Z
Learning: In the CodeRabbit documentation, image paths in markdown files should reference the `/img/` directory, not `/static/img/`.
🪛 markdownlint-cli2 (0.17.2)
docs/platforms/bitbucket-cloud.md
55-55: Hard tabs
Column: 1
(MD010, no-hard-tabs)
56-56: Hard tabs
Column: 1
(MD010, no-hard-tabs)
57-57: Hard tabs
Column: 1
(MD010, no-hard-tabs)
58-58: Hard tabs
Column: 1
(MD010, no-hard-tabs)
59-59: Hard tabs
Column: 1
(MD010, no-hard-tabs)
60-60: Hard tabs
Column: 1
(MD010, no-hard-tabs)
61-61: Hard tabs
Column: 1
(MD010, no-hard-tabs)
62-62: Hard tabs
Column: 1
(MD010, no-hard-tabs)
63-63: Hard tabs
Column: 1
(MD010, no-hard-tabs)
64-64: Hard tabs
Column: 1
(MD010, no-hard-tabs)
65-65: Hard tabs
Column: 1
(MD010, no-hard-tabs)
66-66: Hard tabs
Column: 1
(MD010, no-hard-tabs)
67-67: Hard tabs
Column: 1
(MD010, no-hard-tabs)
68-68: Hard tabs
Column: 1
(MD010, no-hard-tabs)
🪛 LanguageTool
docs/platforms/bitbucket-cloud.md
[typographical] ~120-~120: It seems that a comma is missing.
Context: ...hook. If you cannot install the webhook please check that your Bitbucket user has the ...
(IF_PLEASE_COMMA)
[style] ~120-~120: Try using a more formal synonym for ‘check’.
Context: ...f you cannot install the webhook please check that your Bitbucket user has the necess...
(VERIFY)
Deploying coderabbit-docs with
|
| Latest commit: |
df531ba
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://6b69bd0d.coderabbit-docs.pages.dev |
| Branch Preview URL: | https://update-bitbucket-docs-after.coderabbit-docs.pages.dev |
| @@ -13,90 +13,98 @@ CodeRabbit integrates with Bitbucket Cloud to enhance code review and collaborat | |||
|
|
|||
| This guide will assist you in effectively integrating CodeRabbit with Bitbucket Cloud. | |||
|
|
|||
| ## Configure App Password | |||
| ## Configure Api Token | |||
|
|
||
| To enable CodeRabbit to interact with your Bitbucket repositories, an app password is required. This token grants the necessary permissions for interacting with the Merge Requests and Discussions APIs. | ||
| To enable CodeRabbit to interact with your Bitbucket repositories, an api token is required. This token grants the |
|
|
||
| To enable CodeRabbit to interact with your Bitbucket repositories, an app password is required. This token grants the necessary permissions for interacting with the Merge Requests and Discussions APIs. | ||
| To enable CodeRabbit to interact with your Bitbucket repositories, an api token is required. This token grants the | ||
| necessary permissions for interacting with the Merge Requests and Discussions APIs. |
There was a problem hiding this comment.
Whose APIs are these, Bitbucket's? I think it would be good to be specific about that, just to clarify that these aren't CodeRabbit APIs that you should know about.
How about rephrasing to "[...] interacting with the Bitbucket merge request and discussion APIs"
| 4. Generate an App Password to enable seamless integration between CodeRabbit and your Bitbucket repositories. | ||
| 3. If your Bitbucket workspace requires two-step verification, then you must also enable two-step verification on this | ||
| new account. | ||
| 4. Generate an Api Token to enable seamless integration between CodeRabbit and your Bitbucket repositories. |
|
|
||
| :::note | ||
|
|
||
| If you wish to change the review user, you must provide the app password for the new user who will post reviews and comments. However, this requires manually removing the previous user from the projects and associated webhooks. Once this is done, you will need to reinstall the CodeRabbit app for each project. | ||
| If you wish to change the review user, you must provide the api token for the new user who will post reviews and |
| 19. read:pullrequest:bitbucket | ||
| 20. write:pullrequest:bitbucket | ||
| 21. Click **Create** | ||
| 22. Note down the api token as it will only be displayed once. | ||
|
|
||
| <div class="center-image"> |
There was a problem hiding this comment.
Let's drop this screenshot entirely. It just repeats the list of scopes from above, except it's harder to read.
| /> | ||
| </div> | ||
|
|
||
| ### Where to Provide CodeRabbit the App Password | ||
| ### Where to Provide CodeRabbit the Api Token |
There was a problem hiding this comment.
Provide CodeRabbit with the API Token
|
|
||
| By default, if no app password is provided, CodeRabbit will prompt you to provide one during the installation process. However, if you wish to provide the token beforehand, you can do so by navigating to the **Organization Settings** tab, and selecting the **Bitbucket User** tab on the sidebar. Once entering the app password, the password will be validated and saved for future use. | ||
| By default, if no api token is provided, CodeRabbit will prompt you to provide one during the installation process. |
| By default, if no app password is provided, CodeRabbit will prompt you to provide one during the installation process. However, if you wish to provide the token beforehand, you can do so by navigating to the **Organization Settings** tab, and selecting the **Bitbucket User** tab on the sidebar. Once entering the app password, the password will be validated and saved for future use. | ||
| By default, if no api token is provided, CodeRabbit will prompt you to provide one during the installation process. | ||
| However, if you wish to provide the token beforehand, you can do so by navigating to the **Organization Settings** tab, | ||
| and selecting the **Bitbucket User** tab on the sidebar. Once entering the api token, the token will be validated and |
|
|
||
| Then refresh the repository page in the CodeRabbit app and you can reinstall the webhook. | ||
|
|
||
| If you cannot install the webhook please check that your Bitbucket user has the necessary permissions to install the webhook and the App Password is properly configured. | ||
| If you cannot install the webhook please check that your Bitbucket user has the necessary permissions to install the | ||
| webhook and the Api Token is properly configured. |
No description provided.