mirror of
https://github.com/renovatebot/renovate.git
synced 2024-12-22 21:48:32 +00:00
2bc6e2d3d1
Co-authored-by: Rhys Arkins <rhys@arkins.net> Co-authored-by: Michael Kriese <michael.kriese@visualon.de>
51 lines
3.1 KiB
Markdown
51 lines
3.1 KiB
Markdown
# Bitbucket Cloud
|
|
|
|
Most of the information on this page is meant for users who want to self-host Renovate on Bitbucket Cloud.
|
|
|
|
## Easiest way to run Renovate
|
|
|
|
For most users, the easiest way to get started is to install [the Mend app for Bitbucket](https://marketplace.atlassian.com/apps/1232072/mend?tab=overview&hosting=cloud) and use the free Renovate plan.
|
|
When you use the app, Mend will:
|
|
|
|
- authenticate the app to Bitbucket Cloud
|
|
- keep the tokens safe
|
|
- maintain and update the Renovate version used
|
|
|
|
If you self-host Renovate you must do the things listed above yourself.
|
|
Self-hosting is meant for users with advanced use cases, or who want to be in full control of the bot and the environment it runs in.
|
|
We recommend most users install the Mend app.
|
|
|
|
Read the [Security and Permissions](../../../security-and-permissions.md) page to learn about the Security and Permissions needed for the Mend app.
|
|
|
|
After you installed the hosted app, please read the [reading list](../../../reading-list.md) to learn how to use and configure Renovate.
|
|
|
|
## Authentication
|
|
|
|
First, [create an app password](https://support.atlassian.com/bitbucket-cloud/docs/app-passwords/) for the bot account.
|
|
Give the bot app password the following permission scopes:
|
|
|
|
| Permission | Scope |
|
|
| ---------------------------------------------------------------------------------------------------- | -------------------------- |
|
|
| [`account`](https://developer.atlassian.com/cloud/bitbucket/rest/intro/#account) | Account: Read |
|
|
| [`team`](https://developer.atlassian.com/cloud/bitbucket/rest/intro/#team) | Workspace membership: Read |
|
|
| [`issue:write`](https://developer.atlassian.com/cloud/bitbucket/rest/intro/#issue-write) | Issues: Write |
|
|
| [`pullrequest:write`](https://developer.atlassian.com/cloud/bitbucket/rest/intro/#pullrequest-write) | Pull requests: Write |
|
|
|
|
The bot also needs to validate the workspace membership status of pull-request reviewers, for that, [create a new user group](https://support.atlassian.com/bitbucket-cloud/docs/organize-workspace-members-into-groups/) in the workspace with the **Create repositories** permission and add the bot user to it.
|
|
|
|
Let Renovate use your app password by doing _one_ of the following:
|
|
|
|
- Set your app password as a `password` in your `config.js` file
|
|
- Set your app password as an environment variable `RENOVATE_PASSWORD`
|
|
- Set your app password when you run Renovate in the CLI with `--password=`
|
|
|
|
Remember to:
|
|
|
|
- Set the `username` for the bot account (which is _not_ your email address). You can find your username through "Personal Bitbucket settings" on the "Account settings" page for your account
|
|
- Set `platform=bitbucket` somewhere in your Renovate config file
|
|
|
|
## Unsupported platform features/concepts
|
|
|
|
- Adding assignees to PRs not supported (does not seem to be a Bitbucket concept)
|
|
- `automergeStrategy=rebase` not supported by Bitbucket Cloud, see [Jira issue BCLOUD-16610](https://jira.atlassian.com/browse/BCLOUD-16610)
|