Skip to content
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

docs: recommend users install the GitHub or Bitbucket Cloud hosted app #29457

19 changes: 19 additions & 0 deletions lib/modules/platform/bitbucket/readme.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,24 @@
# 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
HonkingGoose marked this conversation as resolved.
Show resolved Hide resolved

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.
HonkingGoose marked this conversation as resolved.
Show resolved Hide resolved
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](./../../../../docs/usage/security-and-permissions.md) page to learn about the Security and Permissions needed for the Mend app.
HonkingGoose marked this conversation as resolved.
Show resolved Hide resolved

After you installed the hosted app, please read the [reading list](./../../../../docs/usage/reading-list.md) to learn how to use and configure Renovate.
HonkingGoose marked this conversation as resolved.
Show resolved Hide resolved

## Authentication

First, [create an app password](https://support.atlassian.com/bitbucket-cloud/docs/app-passwords/) for the bot account.
Expand Down
19 changes: 19 additions & 0 deletions lib/modules/platform/github/readme.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,24 @@
# GitHub and GitHub Enterprise Server

Most of the information on this page is meant for users who want to self-host Renovate on GitHub or GitHub Enterprise Server.

## Easiest way to run Renovate

For users on GitHub Cloud (`github.com`), the easiest way to get started is to install [the Mend Renovate app](https://github.com/marketplace/renovate) from the GitHub marketplace.
When you use the app, Mend will:

- authenticate the Renovate app to GitHub
- 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 Renovate app.

Read the [Security and Permissions](./../../../../docs/usage/security-and-permissions.md) page to learn about the Security and Permissions needed for the Mend Renovate app.
HonkingGoose marked this conversation as resolved.
Show resolved Hide resolved

After you installed the hosted app, please read the [reading list](./../../../../docs/usage/reading-list.md) to learn how to use and configure Renovate.
HonkingGoose marked this conversation as resolved.
Show resolved Hide resolved

## Authentication

First, create a [fine-grained](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) _or_ a [classic](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#creating-a-personal-access-token-classic) PAT.
Expand Down
Loading