Skip to content

Updating bitbucket integration docs to account for on-prem #476

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 8, 2025

Conversation

edgarcerecerez
Copy link
Collaborator

@edgarcerecerez edgarcerecerez commented Jul 28, 2025

Removed references to Bitbucket Cloud and left the more ambiguous Bitbucket to account for both on prem and cloud.

Summary by CodeRabbit

  • Documentation
    • Updated references from "Bitbucket Cloud" to "Bitbucket" in the Bitbucket integration guide and added a link to Bitbucket Data Center integration instructions.
    • Removed the future development roadmap documentation.

Removed references to Bitbucket Cloud and left the more ambiguous Bitbucket to account for both on prem and cloud.
Copy link
Contributor

coderabbitai bot commented Jul 28, 2025

📝 Walkthrough

Walkthrough

The Bitbucket Cloud documentation was updated to replace "Bitbucket Cloud" with "Bitbucket" in the sidebar label and most introductory references. A new sentence was added linking to integration instructions for Bitbucket Data Center with CodeRabbit's self-hosted edition. Additionally, the entire future development roadmap document was removed.

Changes

Cohort / File(s) Change Summary
Bitbucket Documentation Branding Update
docs/platforms/bitbucket-cloud.md
Changed sidebar label and most mentions from "Bitbucket Cloud" to "Bitbucket." Added a link to Bitbucket Data Center integration instructions.
Future Development Roadmap Removal
docs/future-development.md
Deleted the entire file outlining planned future enhancements, integrations, and AI improvements.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A bunny hops through docs so bright,
Swapping "Cloud" for "Bitbucket" light.
A link was added, clear and neat,
For Data Center folks to meet.
The roadmap vanished, plans set free—
New paths await for all to see! 🐇✨

Pre-Merge Checks (1 passed, 2 warnings)

❌ Failed Checks (2 warnings)
Check Name Status Explanation Resolution
Title Check ⚠️ Warning The title is not sufficiently specific and uses inconsistent capitalization, which may mislead reviewers about the precise changes made. Revise the pull request title to clearly and accurately reflect the changes, for example: "Rename Bitbucket Cloud to Bitbucket and add on-premises Bitbucket Data Center integration link".
Description Check ⚠️ Warning The description is too brief and does not provide sufficient context, details of the specific documentation updates, or mention of the file deletion and the added on-prem link. Provide a detailed description including a summary of all changed files, the rationale for renaming, the addition of the on-prem link, and note the removal of the future-development.md file, and consider adding a pull request template for consistency.
✅ Passed Checks (1 passed)
Check Name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.

Note

🔌 MCP (Model Context Protocol) integration is now available in Early Access!

Pro users can now connect to remote MCP servers under the Integrations page to get reviews and chat conversations that understand additional development context.


📜 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 b5162cc and 480f868.

📒 Files selected for processing (1)
  • docs/future-development.md (0 hunks)
💤 Files with no reviewable changes (1)
  • docs/future-development.md
🧰 Additional context used
🔍 MCP Research (2 servers)

Context7:

  • The Bitbucket integration documentation is part of the self-hosted CodeRabbit environment configuration, specifically under the "bitbucket-server" self-hosted setup. The .env configuration file for Bitbucket Server includes variables such as BITBUCKET_SERVER_URL, BITBUCKET_SERVER_WEBHOOK_SECRET, BITBUCKET_SERVER_BOT_TOKEN, and BITBUCKET_SERVER_BOT_USERNAME. This indicates that the documentation changes related to Bitbucket should align with these configuration parameters and usage instructions. (docs/self-hosted/bitbucket.md snippet)

  • The CodeRabbit documentation project uses Docusaurus with a defined project structure including sidebar.ts which controls sidebar entries. The change to the sidebar label "Bitbucket" likely involves modifications to this file to reflect the new label and link structure. (docs/README.md project structure snippet)

Linear:

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Cloudflare Pages
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch edgar-minor-fixes-and-tweaks

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@edgarcerecerez edgarcerecerez self-assigned this Jul 28, 2025
Copy link

cloudflare-workers-and-pages bot commented Jul 28, 2025

Deploying coderabbit-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 6a88fca
Status:🚫  Build failed.

View logs

@edgarcerecerez edgarcerecerez marked this pull request as draft July 28, 2025 16:00
@edgarcerecerez
Copy link
Collaborator Author

Updated the PR to have:

  • Bitbucket on the sidebar. Which points to Bitbucket Cloud docs.
  • The Bitbucket Cloud docs have a link out to Bitbucket Data Center.

This solution keeps the focus on Bitbucket Cloud, which it should have. By having Bitbucket on the sidebar (as opposed to Bitbucket Cloud) it infers that we support Bitbucket generally.

@edgarcerecerez edgarcerecerez marked this pull request as ready for review July 28, 2025 16:11
@edgarcerecerez edgarcerecerez removed their assignment Aug 7, 2025
@edgarcerecerez edgarcerecerez merged commit e34339b into main Aug 8, 2025
1 of 4 checks passed
@edgarcerecerez edgarcerecerez deleted the edgar-minor-fixes-and-tweaks branch August 8, 2025 04:58
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.

1 participant