From 2bc6e2d3d1acf9ea4cc4120eb8fa8ea0a0853a4d Mon Sep 17 00:00:00 2001 From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> Date: Fri, 21 Jun 2024 15:09:12 +0200 Subject: [PATCH] docs: recommend users install the GitHub or Bitbucket Cloud hosted app (#29457) Co-authored-by: Rhys Arkins <rhys@arkins.net> Co-authored-by: Michael Kriese <michael.kriese@visualon.de> --- lib/modules/platform/bitbucket/readme.md | 19 +++++++++++++++++++ lib/modules/platform/github/readme.md | 19 +++++++++++++++++++ 2 files changed, 38 insertions(+) diff --git a/lib/modules/platform/bitbucket/readme.md b/lib/modules/platform/bitbucket/readme.md index 6cfe0cc75b..7053ae2c31 100644 --- a/lib/modules/platform/bitbucket/readme.md +++ b/lib/modules/platform/bitbucket/readme.md @@ -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 + +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. diff --git a/lib/modules/platform/github/readme.md b/lib/modules/platform/github/readme.md index 996e218042..9e0dd06b1f 100644 --- a/lib/modules/platform/github/readme.md +++ b/lib/modules/platform/github/readme.md @@ -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](../../../security-and-permissions.md) page to learn about the Security and Permissions needed for the Mend Renovate 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 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. -- GitLab