From 1807efad0b83b3116de3d421db92049f11a3455a Mon Sep 17 00:00:00 2001 From: Rohit Malhotra Date: Wed, 18 Jun 2025 05:56:36 -0400 Subject: [PATCH] Add Bitbucket integration documentation for local usage (#9206) Co-authored-by: openhands --- docs/usage/cloud/github-installation.mdx | 2 +- docs/usage/how-to/gui-mode.mdx | 40 ++++++++++++++++++++++-- 2 files changed, 39 insertions(+), 3 deletions(-) diff --git a/docs/usage/cloud/github-installation.mdx b/docs/usage/cloud/github-installation.mdx index eb25cab10e..d4ad0b1f2f 100644 --- a/docs/usage/cloud/github-installation.mdx +++ b/docs/usage/cloud/github-installation.mdx @@ -35,7 +35,7 @@ You can grant OpenHands access to specific GitHub repositories: You can modify GitHub repository access at any time by: - Selecting `Add GitHub repos` on the landing page or -- Visiting the Settings page and selecting `Configure GitHub Repositories` under the `Git` tab +- Visiting the Settings page and selecting `Configure GitHub Repositories` under the `Integrations` tab ## Working With GitHub Repos in Openhands Cloud diff --git a/docs/usage/how-to/gui-mode.mdx b/docs/usage/how-to/gui-mode.mdx index e194331843..d1e24dd898 100644 --- a/docs/usage/how-to/gui-mode.mdx +++ b/docs/usage/how-to/gui-mode.mdx @@ -45,7 +45,7 @@ OpenHands automatically exports a `GITHUB_TOKEN` to the shell environment if pro - All Repositories (You can select specific repositories, but this will impact what returns in repo search) - Minimal Permissions (Select `Meta Data = Read-only` read for search, `Pull Requests = Read and Write` and `Content = Read and Write` for branch creation) 2. **Enter Token in OpenHands**: - - In the Settings page, navigate to the `Git` tab. + - In the Settings page, navigate to the `Integrations` tab. - Paste your token in the `GitHub Token` field. - Click `Save Changes` to apply the changes. @@ -97,7 +97,7 @@ OpenHands automatically exports a `GITLAB_TOKEN` to the shell environment if pro - `write_repository` (Write repository) - Set an expiration date or leave it blank for a non-expiring token. 2. **Enter Token in OpenHands**: - - In the Settings page, navigate to the `Git` tab. + - In the Settings page, navigate to the `Integrations` tab. - Paste your token in the `GitLab Token` field. - Click `Save Changes` to apply the changes. @@ -122,6 +122,42 @@ OpenHands automatically exports a `GITLAB_TOKEN` to the shell environment if pro +#### BitBucket Setup (Coming soon ...) + + +1. **Generate an App Password**: + - On BitBucket, go to Personal Settings > App Password. + - Create a new password with the following scopes: + - `repository: read` + - `repository: write` + - `pull requests: read` + - `pull requests: write` + - `issues: read` + - `issues: write` + - App passwords are non-expiring token. OpenHands will migrate to using API tokens in the future. + 2. **Enter Token in OpenHands**: + - In the Settings page, navigate to the `Integrations` tab. + - Paste your token in the `BitBucket Token` field. + - Click `Save Changes` to apply the changes. + + + + Common issues and solutions: + + - **Token Not Recognized**: + - Ensure the token is properly saved in settings. + - Check that the token hasn't expired. + - Verify the token has the required scopes. + + - **Verifying Token Works**: + - The app will show a green checkmark if the token is valid. + - Try accessing a repository to confirm permissions. + - Check the browser console for any error messages. + + + + + #### Secrets Management OpenHands provides a secrets manager that allows you to securely store and manage sensitive information that can be accessed by the agent during runtime, such as API keys. These secrets are automatically exported as environment variables in the agent's runtime environment.