Connecting to Bitbucket
If you authorize Appcircle to access your repositories on Bitbucket, you can select the repository that you want to connect in the next screen.
After you click on Bitbucket, the following screen will appear. This will let you choose between selecting a repository that you are already authorized to do with Appcircle or asking your consent about authorizing more repositories.
When you successfully authorize your account, the following screen will appear to let you select one for connection:
After the connection is successful, you can view your newly created profile and start building!
Connecting to Bitbucket Cloud Repository
To connect to a Bitbucket Cloud repository using either OAuth or Personal Access Token,
- OAuth Connection
Clicking on Get Repositories from Bitbucket Cloud for the first time will require application access to Appcircle, and this access will require these permissions in order to work properly.
- PAT (Personal Access Token) Connection or Bitbucket App Password
Clicking on Connect to a Bitbucket server, which can be selected to connect to self-hosted and PAT connections, will require a token or password. Generating an app password or a PAT for Appcircle will require a list of permissions down below.
OAuth Permissions for Bitbucket Integration
The following table details the OAuth permissions required for Appcircle to connect with Bitbucket. These permissions grant read access to projects, repositories, pull requests, and webhooks, ensuring proper functionality when integrating with Bitbucket via OAuth.
| Scope | Permission | Description |
|---|---|---|
| Account | Provides access to view the user's primary email address. | |
| Project | Read | Provides access to view the projects the user has access to view. Read access (repository) to all the repositories in the projects is also granted. |
| Repository | Read | Provides access to view all the repositories the user has access to view, including the source code, Issues, and Wiki. This does not include pull requests. |
| Pull Request | Read | Provides access to view and list pull requests on the repositories the user has access to view. This permission (scope) also allows the user to create and resolve tasks. |
| Webhooks | Read & Write | Required for webhook operations. For Appcircle triggers to work. |
Connecting to Bitbucket Self Hosted Repository
The overall process is similar with a private repository connection through SSH, but Appcircle allows you to directly connect through the Bitbucket Self-Hosted URL.
Bitbucket's version must be 7.14 or higher.
First, select Bitbucket then Connect to a Bitbucket Server through the menu:
Fill in the relevant information about your Bitbucket self-hosted module. If you are not sure what those are, contact your system administrator.
Connection Notice
For Appcircle to connect to the self-hosted Bitbucket instance, your connection must be reachable over the internet.
Is your self-hosted Bitbucket instance under an enterprise firewall? Learn which IP addresses and ports Appcircle uses to function under the whitelist documentation:
Accessing Repositories in Internal Networks (Firewalls)
Token Creation
Bitbucket has Personal Access Token to authorize the user. Relevant guide:
Appcircle needs admin permission to function properly. The admin permission is needed to create relevant WebHooks automatically.
Bitbucket doesn't allow scoped repository permissions like GitHub. Therefore the token you add can access all the repositories of the token's owner. When you're adding a token, it's better to create a new bot user or a project and give access to only the required repositories for build to succeed.
When connecting to a Bitbucket Server, use a Personal HTTP Access Token instead of a HTTP access token for projects or repositories. Not using a Personal Access Token may lead to failures in build and fetch operations on Appcircle.
Check Token
You can follow the steps below to check if your token is valid.
- Open the terminal and issue the following command
curl --user name:password http://YOUR_BITBUCKET_HOST/rest/api/1.0/repos
Above command should print out your projects. If you don't see an output, please check your token and Bitbucket address.
Please also make sure that the output doesn't show any reference to localhost. If you see localhost, you need to configure Bitbucket and put the correct address of your Bitbucket instance.
Need help?
Get help from Appcircle's support team, or see how others are using Appcircle by joining our Slack Channel.