Skip to content

Bitbucket Docs Update [Request] #347

Closed
@karan925

Description

@karan925
Collaborator

Can we add to our https://docs.coderabbit.ai/platforms/bitbucket-cloud either as a note or something, maybe just before App password creation,

If the Organization (workspace) has MFA enabled, then the CodeRabbit Bot User will also need to have MFA setup and enabled. Then they should create the app password and provide it to us.

We had a customer who had this setup, but didn't have MFA enabled for the CodeRabbit Service account they created. After a bunch of debugging, it started working

Activity

traycerai

traycerai commented on May 16, 2025

@traycerai

Plan

Observations

The Bitbucket Cloud docs (docs/platforms/bitbucket-cloud.md) cover app password generation but lack any mention of multi-factor authentication (MFA). This file consistently uses Docusaurus triple-colon admonitions (:::note) for highlighting important info. The “Generating an App password” section is the natural insertion point for an MFA reminder. Official Atlassian documentation for two-step verification is available at https://support.atlassian.com/bitbucket-cloud/docs/enable-two-step-verification/.

Approach

Modify the Markdown file to insert a concise admonition using the existing :::note syntax immediately above the “Generating an App password” heading. The note will inform readers that MFA must also be enabled on the CodeRabbit Bot service account if the workspace enforces MFA, and link to the Atlassian guide. After editing, preview locally with the Docusaurus dev server to ensure consistent rendering, then commit and open a PR.

Reasoning

I analyzed the file structure and style of the Bitbucket Cloud docs, confirmed absence of any MFA guidance, researched Atlassian MFA links, and drafted precise copy aligning with existing note conventions.

Proposed File Changes

📄 docs/platforms/bitbucket-cloud.md (MODIFY) 🔗

References

Open docs/platforms/bitbucket-cloud.md. Locate the heading ## Generating an App password (around line 52). Immediately above this line, insert a new admonition block using the :::note syntax:

:::note
If your Bitbucket Cloud workspace enforces multi-factor authentication (MFA), you must also enable MFA on the CodeRabbit Bot service account before creating an app password. For details on setting up two-step verification, see the [Atlassian guide](https://support.atlassian.com/bitbucket-cloud/docs/enable-two-step-verification/).
:::

Ensure the formatting, indentation, and spacing match existing notes. Save the file.

Import In IDE

VSCode Icon Cursor Icon Windsurf Icon

Developer Humor

Here’s to securing our bots!
No more MFA mysteries—
Just a quick note before you type your password,
And our CodeRabbit will hop right to work. 🐇🔒
High-five for safer integrations! 🙌


Execution Information

Branch: main
Commit: a3f2a46


💡 Tips

Supported Commands (Inside Comments)

  • Use @traycerai generate to iterate on the previous version of the implementation plan.

Supported Commands (Inside Description)

  • Add @traycerai ignore anywhere in the ticket description to prevent this ticket from being processed.
  • Add @traycerai branch:<branch-name> anywhere in the ticket description to specify the target branch for the implementation plan.

Community

  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.
added
needs triageA new docs bug that needs to be processed and planned by the docs project owners
on May 19, 2025
self-assigned this
on Jun 2, 2025
removed
needs triageA new docs bug that needs to be processed and planned by the docs project owners
on Jun 2, 2025
jmacdotorg

jmacdotorg commented on Jun 2, 2025

@jmacdotorg
Contributor

@karan925 I think a simple step would suffice here; have a look.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

    Development

    Participants

    @jmacdotorg@karan925

    Issue actions

      Bitbucket Docs Update [Request] · Issue #347 · coderabbitai/coderabbit-docs