From 124c1e636c39e823cb6b06a1054ac94c85c3c77f Mon Sep 17 00:00:00 2001 From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> Date: Thu, 13 Jul 2023 16:24:43 +0200 Subject: [PATCH] docs: refer to the app as the Mend Renovate app (#23336) Co-authored-by: Rhys Arkins <rhys@arkins.net> --- docs/development/style-guide.md | 4 +++ docs/usage/configuration-options.md | 8 ++--- docs/usage/faq.md | 18 +++++------ .../getting-started/installing-onboarding.md | 10 +++---- .../usage/getting-started/private-packages.md | 10 +++---- docs/usage/getting-started/running.md | 8 ++--- docs/usage/key-concepts/automerge.md | 2 +- docs/usage/key-concepts/scheduling.md | 2 +- docs/usage/known-limitations.md | 4 +-- docs/usage/merge-confidence.md | 6 ++-- docs/usage/node.md | 2 +- docs/usage/noise-reduction.md | 2 +- docs/usage/php.md | 2 +- docs/usage/reading-list.md | 2 +- docs/usage/security-and-permissions.md | 30 +++++++++---------- docs/usage/self-hosted-configuration.md | 2 +- docs/usage/troubleshooting.md | 4 +-- docs/usage/user-stories/swissquote.md | 2 +- lib/modules/manager/bundler/readme.md | 2 +- lib/modules/manager/gomod/readme.md | 2 +- readme.md | 9 +++--- 21 files changed, 67 insertions(+), 64 deletions(-) diff --git a/docs/development/style-guide.md b/docs/development/style-guide.md index bece048626..9562b9ce50 100644 --- a/docs/development/style-guide.md +++ b/docs/development/style-guide.md @@ -13,3 +13,7 @@ Set your spell checker to the correct language. ## Use plain language Follow the [Plain language guidelines](https://www.plainlanguage.gov/guidelines/). + +## Correct name for the GitHub app + +Refer to the GitHub app version of Renovate as "the Mend Renovate app". diff --git a/docs/usage/configuration-options.md b/docs/usage/configuration-options.md index 58d658bf12..b4050fbc18 100644 --- a/docs/usage/configuration-options.md +++ b/docs/usage/configuration-options.md @@ -870,7 +870,7 @@ For the full list of available managers, see the [Supported Managers](https://do Before you put any secrets in your repository configuration, encrypt the secrets. You can encrypt secrets using either a HTML page, or the CLI. -To encrypt secrets for the hosted Mend Renovate app for github.com with a HTML page, go to [app.renovatebot.com/encrypt](https://app.renovatebot.com/encrypt) and complete the form. +To encrypt secrets for the Mend Renovate App for github.com with a HTML page, go to [app.renovatebot.com/encrypt](https://app.renovatebot.com/encrypt) and complete the form. If you're self-hosting Renovate, you may download and edit the form, to use your own PGP public key. You can also encrypt secrets from the CLI, using the `curl`, `echo`, `jq`, `gpg`, `grep` and `tr` CLI programs. @@ -1084,7 +1084,7 @@ If you want Renovate to run on a forked repository when in `autodiscover` mode t If you're running Renovate in some other mode, for example when giving a list of repositories to Renovate, but want to skip forked repositories: set `"forkProcessing": "disabled"` in your _global_ config. -**When using the hosted GitHub Mend Renovate app** +**When using the Mend Renovate App** The behavior of `forkProcessing` depends on how you allow Renovate to run on your account. @@ -1587,7 +1587,7 @@ Applicable for Composer only for now. ## ignorePrAuthor -This is usually needed if someone needs to migrate bot accounts, including from hosted app to self-hosted. +This is usually needed if someone needs to migrate bot accounts, including from the Mend Renovate App to self-hosted. If `ignorePrAuthor` is configured to true, it means Renovate will fetch the entire list of repository PRs instead of optimizing to fetch only those PRs which it created itself. You should only want to enable this if you are changing the bot account (e.g. from `@old-bot` to `@new-bot`) and want `@new-bot` to find and update any existing PRs created by `@old-bot`. It's recommended to revert this setting once that transition period is over and all old PRs are resolved. @@ -3559,7 +3559,7 @@ Follow these steps: 1. Enable the "Dependency graph" 1. Enable "Dependabot alerts" 1. If you're running Renovate in app mode: make sure the app has `read` permissions for "Vulnerability alerts". - If you're the account administrator, browse to the app (for example [https://github.com/apps/renovate](https://github.com/apps/renovate)), select "Configure", and then scroll down to the "Permissions" section and make sure that `read` access to "vulnerability alerts" is mentioned + If you're the account administrator, browse to the app (for example [the Mend Renovate App](https://github.com/apps/renovate)), select "Configure", and then scroll down to the "Permissions" section and make sure that `read` access to "vulnerability alerts" is mentioned Once the above conditions are met, and you got one or more vulnerability alerts from GitHub for this repository, then Renovate tries to raise fix PRs. diff --git a/docs/usage/faq.md b/docs/usage/faq.md index 2bfc0c4868..b083c75144 100644 --- a/docs/usage/faq.md +++ b/docs/usage/faq.md @@ -23,25 +23,25 @@ Renovate will: Only the latest version of Renovate is supported by the Renovate maintainers. The Renovate team only fixes bugs in an older version if: -- the hosted app needs to stay on that older major version for a short time, or +- the Mend Renovate App needs to stay on that older major version for a short time, or - some critical bug needs to be fixed and the new major is blocked -If you're using the hosted app, you don't need to do anything, as the Renovate maintainers update the hosted app regularly. +If you're using the Mend Renovate App, you don't need to do anything, as the Renovate maintainers update it regularly. If you're self hosting Renovate, use the latest release if possible. -## When is the Mend Renovate GitHub hosted app updated with new Renovate versions? +## When is the Mend Renovate App updated with new Renovate versions? -The Renovate maintainers manually update the GitHub hosted app. +The Renovate maintainers manually update the app. The maintainers don't follow any release schedule or release cadence. -This means the hosted app can lag a few hours to a week behind the open source version. +This means the Mend Renovate App can lag a few hours to a week behind the open source version. Major releases of Renovate are held back until the maintainers are reasonably certain it works for most users. ## Renovate core features not supported on all platforms -| Feature | Platforms which lack feature | See Renovate issue(s) | -| -------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | -| Dependency Dashboard | Azure, Bitbucket, Bitbucket Server | [#9592](https://github.com/renovatebot/renovate/issues/9592) | -| Hosted app | Azure, Bitbucket, Bitbucket Server, Forgejo, Gitea, GitLab | | +| Feature | Platforms which lack feature | See Renovate issue(s) | +| --------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | +| Dependency Dashboard | Azure, Bitbucket, Bitbucket Server | [#9592](https://github.com/renovatebot/renovate/issues/9592) | +| The Mend Renovate App | Azure, Bitbucket, Bitbucket Server, Forgejo, Gitea, GitLab | | ## Major platform features not supported by Renovate diff --git a/docs/usage/getting-started/installing-onboarding.md b/docs/usage/getting-started/installing-onboarding.md index 1cfcb77976..7b4cf08d1c 100644 --- a/docs/usage/getting-started/installing-onboarding.md +++ b/docs/usage/getting-started/installing-onboarding.md @@ -9,19 +9,19 @@ If the administrator has configured a fixed list of repositories then the only w Otherwise, the process for adding new repositories to a Renovate installation can vary: - Most commonly, you run Renovate as a dedicated "bot user" with global config option `autodiscover` set to `true`, meaning that it will run on every repository which it's been granted access to -- If using a GitHub App (including Mend Renovate on `github.com`) then you can install the app into a user or organization account and select either "All repositories", or "Select repositories" and pick them manually +- If using a GitHub App (including the Mend Renovate App) then you can install the app into a user or organization account and select either "All repositories", or "Select repositories" and pick them manually ### Hosted GitHub.com App -Follow these steps to install and enable Mend's Renovate GitHub App: +Follow these steps to install and enable the Mend Renovate App: First, navigate to [https://github.com/apps/renovate](https://github.com/apps/renovate) and select the Install button: -{ loading=lazy } +{ loading=lazy } The only choice you need to make is whether to run Renovate on all repositories or on selected repositories: -{ loading=lazy } +{ loading=lazy } Renovate will ignore any repositories that don't have known package files, as well as any forks, so you can enable Renovate for all your repositories with no problems. That said, most people run Renovate on selected repositories. @@ -147,4 +147,4 @@ Any existing Renovate PRs will be closed after you've completed these steps. 1. Remove the current Renovate configuration file (e.g. `renovate.json`) from your mainline branch Following these steps will trick Renovate into thinking that your repository was _never_ onboarded, and will trigger a new "Configure Renovate" PR. -If you're using the hosted Mend Renovate App and you don't get a new onboarding PR within a few hours, then please create a Discussions post to request staff trigger it manually. +If you're using the Mend Renovate App and you don't get a new onboarding PR within a few hours, then please create a Discussions post to request staff trigger it manually. diff --git a/docs/usage/getting-started/private-packages.md b/docs/usage/getting-started/private-packages.md index c862a1641a..b3fc8e84fc 100644 --- a/docs/usage/getting-started/private-packages.md +++ b/docs/usage/getting-started/private-packages.md @@ -230,8 +230,8 @@ If you need to configure per-repository credentials then you can also configure The recommended approaches in order of preference are: 1. **Self-hosted hostRules**: Configure a hostRules entry in the bot's `config.js` with the `hostType`, `matchHost` and `token` specified -1. **Renovate App with private modules from npmjs.org**: Add an encrypted `npmToken` to your Renovate config -1. **Renovate App with a private registry**: Add an plaintext `npmrc` plus an encrypted `npmToken` in config +1. **The Mend Renovate App with private modules from npmjs.org**: Add an encrypted `npmToken` to your Renovate config +1. **The Mend Renovate App with a private registry**: Add an plaintext `npmrc` plus an encrypted `npmToken` in config These approaches are described in full below. @@ -476,9 +476,9 @@ module.exports = { }; ``` -## Mend Renovate Hosted App Encryption +## Encryption and the Mend Renovate App -The popular [Renovate App on GitHub](https://github.com/apps/renovate) is hosted by Mend. +Many users use [the Mend Renovate App](https://github.com/apps/renovate), which is hosted by Mend. If you are a user of this app, and have private modules, then the following is applicable. ### Private presets with public repositories @@ -494,7 +494,7 @@ The solution to this is that you should break your presets into public and priva It is strongly recommended that you avoid committing secrets to repositories, including private ones, and this includes secrets needed by Renovate to access private modules. The preferred approach to secrets is that the bot administrator configures them as `hostRules` which are then applied to all repositories which the bot accesses. -If you need to provide credentials to the hosted Renovate App, please do this: +If you need to provide credentials to the Mend Renovate App, please do this: - Encrypt each secret string using <https://app.renovatebot.com/encrypt>. Note: this encrypts using the app's public key fully in the browser and does not send the original secret to any server. You can download this file and perform the encryption fully offline if you like. - Wrap each secret field in an [encrypted](../configuration-options.md#encrypted) object and paste in the encrypted secret value instead. An example is shown below: diff --git a/docs/usage/getting-started/running.md b/docs/usage/getting-started/running.md index 3a36865281..c8bc0d0ad2 100644 --- a/docs/usage/getting-started/running.md +++ b/docs/usage/getting-started/running.md @@ -2,11 +2,11 @@ As end user, you can choose from these ways to run Renovate: -- You use the Mend Renovate app on GitHub, or +- You use the Mend Renovate App, or - You self-host Renovate, for example by running the pre-built Docker image, or - Someone else is hosting Renovate, and you install/configure it for the repositories you choose -If you're using the Mend Renovate App on GitHub, or if someone else is hosting Renovate for you, skip ahead to the [installing & onboarding](./installing-onboarding.md) page. +If you're using the Mend Renovate App, or if someone else is hosting Renovate for you, skip ahead to the [installing & onboarding](./installing-onboarding.md) page. ## Self-Hosting Renovate @@ -104,11 +104,11 @@ Mend Remediate supports GitHub Enterprise Server, GitLab self-hosted, and Bitbuc #### Forking Renovate app -"Forking Renovate" is the sister app to the Mend Renovate App on GitHub.com. +"Forking Renovate" is the sister app to the Mend Renovate App. The difference is that Forking Renovate does not need `write` permissions to create branches within the repo, and instead submits PRs from its own fork. Because of how it works, it functions on public repositories only and additionally cannot support `automerge` capabilities. -[Install Forking Renovate from GitHub App](https://github.com/apps/forking-renovate). +[Install Forking Renovate from GitHub App store](https://github.com/apps/forking-renovate). ##### Benefits diff --git a/docs/usage/key-concepts/automerge.md b/docs/usage/key-concepts/automerge.md index d4203845fb..51df1a62e5 100644 --- a/docs/usage/key-concepts/automerge.md +++ b/docs/usage/key-concepts/automerge.md @@ -248,7 +248,7 @@ If you have mandatory Pull Request reviews then it means Renovate can't automerg If you're on `github.com` or GitHub Enterprise Server (`>=3.4`) you can let Renovate bypass the mandatory Pull Request reviews using the "[Allow specified actors to bypass required pull requests](https://github.blog/changelog/2021-11-19-allow-bypassing-required-pull-requests/)" option in your branch protection rules. -Alternatively, if you are running the hosted Mend Renovate App on `github.com`, you can also install the helper apps [renovate-approve](https://github.com/apps/renovate-approve) and [renovate-approve-2](https://github.com/apps/renovate-approve-2) and they will mark all automerging Pull Requests by Renovate as approved. +Alternatively, if you use the Mend Renovate App, you can also install the helper apps [renovate-approve](https://github.com/apps/renovate-approve) and [renovate-approve-2](https://github.com/apps/renovate-approve-2) and they will mark all automerging Pull Requests by Renovate as approved. These approval helper apps are only available for GitHub. ### Codeowners diff --git a/docs/usage/key-concepts/scheduling.md b/docs/usage/key-concepts/scheduling.md index e70929066e..dc7e43fef8 100644 --- a/docs/usage/key-concepts/scheduling.md +++ b/docs/usage/key-concepts/scheduling.md @@ -88,7 +88,7 @@ The _@breejs/later_ library also handles the concepts of "days", time_before", a ### In repository schedule configuration Reminder: the times when the Renovate process runs are controlled by the bot admin using tools such as `cron`. -If you use the GitHub hosted app, the default is that Renovate will always be allowed to run. +If you use the Mend Renovate App, the default is that Renovate will always be allowed to run. Be sure to schedule enough time for Renovate to process your repository. Do not set schedules like "Run Renovate for an hour each Sunday" as you _will_ run into problems. diff --git a/docs/usage/known-limitations.md b/docs/usage/known-limitations.md index 60d186d672..3886a9d9fa 100644 --- a/docs/usage/known-limitations.md +++ b/docs/usage/known-limitations.md @@ -21,9 +21,9 @@ For scheduled action to take place, both these need to happen: - The bot needs to run against your repository - The current time needs to fall within your repository's configured schedule -### GitHub hosted app scheduled jobs +### The Mend Renovatate app and scheduled jobs -On the GitHub hosted app Mend checks each active repository roughly every three hours, if no activity has been seen before then (merged PRs, etc). +The Mend Renovate App checks each active repository roughly every three hours, if no activity has been seen before then (merged PRs, etc). For this reason, you should set your schedule window to at least three or four hours. This makes it likely that Renovate bot checks your repository at least once during the schedule. diff --git a/docs/usage/merge-confidence.md b/docs/usage/merge-confidence.md index aba870267e..284d6c9129 100644 --- a/docs/usage/merge-confidence.md +++ b/docs/usage/merge-confidence.md @@ -6,7 +6,7 @@ Look at the Merge Confidence badges before merging to: - See at a glance if you should update Merge Confidence finds and flags undeclared breaking releases. -It analyzes test and release adoption data across Mend Renovate’s early-adopting user base. +It analyzes test and release adoption data from the Mend Renovate App users.  @@ -49,7 +49,7 @@ If you're self-hosting Renovate, you can enable the badges by adding the `mergeC !!! note The `mergeConfidence:age-confidence-badges` preset can be used to only show the Age and Confidence badges. -If you want to disable the badges in the app, add the `mergeConfidence:all-badges` preset to the `ignorePresets` array in your config: +If you want to disable the badges in the Mend Renovate App, add the `mergeConfidence:all-badges` preset to the `ignorePresets` array in your config: ```json { @@ -68,7 +68,7 @@ Merge Confidence uses the following confidence levels: ## How it works -Mend's hosted Renovate App has created millions of pull requests on `github.com` to help developers update their dependencies since 2017. +The Mend Renovate App created millions of pull requests on `github.com` to help developers update their dependencies since 2017. We bundle and analyze metrics such as package `Age`, package `Adoption`, and `Passing` tests. This way we can find packages that have undeclared breaking changes. diff --git a/docs/usage/node.md b/docs/usage/node.md index 0f50e2163b..6383483441 100644 --- a/docs/usage/node.md +++ b/docs/usage/node.md @@ -25,7 +25,7 @@ Renovate can manage the Node.js version in the following files: ## Configuring which version of npm Renovate uses -When `binarySource=docker`, such as in the hosted Mend Renovate App, Renovate will choose and install an `npm` version dynamically. +When `binarySource=docker` or `binarySource=install`, such as in the Mend Renovate App, Renovate will choose and install an `npm` version dynamically. To control which version or constraint is installed, you should use the `engines.npm` property in your `package.json` file. Renovate bot will then use that version constraint for npm when it creates a pull request. diff --git a/docs/usage/noise-reduction.md b/docs/usage/noise-reduction.md index 1869a484b5..8f267c48a8 100644 --- a/docs/usage/noise-reduction.md +++ b/docs/usage/noise-reduction.md @@ -59,7 +59,7 @@ For a high level overview of scheduling when Renovate bot runs, read the [key co On its own, the Renovate CLI tool runs once and then exits. Hence, it only runs as often as its administrator sets it to (e.g. via `cron`). -For the [Renovate app on GitHub](https://github.com/apps/renovate), it currently runs continuously using a job queue that gets refreshed hourly, or when you make relevant commits to your repository. +For [the Mend Renovate App](https://github.com/apps/renovate), it currently runs continuously using a job queue that gets refreshed hourly, or when you make relevant commits to your repository. You can expect to get PRs at any time of the day, e.g. soon after versions are published to npm. Receiving PRs at any hour can increase the feeling of being "overwhelmed" by updates and possibly interrupt your flow during working hours, so many Renovate users also consider reducing Renovate's schedule to be outside their normal working hours, for example weeknights and weekends. diff --git a/docs/usage/php.md b/docs/usage/php.md index ddda7185ae..358d14c014 100644 --- a/docs/usage/php.md +++ b/docs/usage/php.md @@ -42,7 +42,7 @@ If you are using a [privately hosted Composer package](https://getcomposer.org/d ``` This host rule is best added to the bot's `config.js` config so that it is not visible to users of the repository. -If you are using the hosted Mend Renovate App then you can encrypt it with Renovate's public key instead, so that only Renovate can decrypt it. +If you are using the Mend Renovate App then you can encrypt it with Renovate's public key instead, so that only Renovate can decrypt it. Go to [https://app.renovatebot.com/encrypt](https://app.renovatebot.com/encrypt), paste in the secret string you wish to encrypt, select _Encrypt_, then copy the encrypted result. You may encrypt your `password` only, but you can encrypt your `username` as well. diff --git a/docs/usage/reading-list.md b/docs/usage/reading-list.md index 76ad793ead..134a46e315 100644 --- a/docs/usage/reading-list.md +++ b/docs/usage/reading-list.md @@ -21,7 +21,7 @@ If you're self-hosting or need to update private packages, complete the relevant If you're new to Renovate, you should: -- Use the Mend-hosted GitHub App, or let somebody else host Renovate for you +- Use the Mend Renovate App, or let someone else host Renovate for you - Stick with the `config:recommended` preset - Use the Dependency Dashboard (`config:recommended` enables it automatically) - Read the pages in the "Beginners" list diff --git a/docs/usage/security-and-permissions.md b/docs/usage/security-and-permissions.md index addd4334e6..e7e0a61baa 100644 --- a/docs/usage/security-and-permissions.md +++ b/docs/usage/security-and-permissions.md @@ -11,7 +11,7 @@ That said, we will try to fix security problems in a reasonable timeframe if pos Renovate the open source project is **not** certified. -The company which maintains Renovate and provides the hosted Renovate App for GitHub is called Mend. +Mend is the company which maintains Renovate and provides the Mend Renovate App. Mend is ISO 27001 and SOC2 certified. ### Security / Disclosure @@ -30,23 +30,23 @@ We apply the Principle of Least Privilege (PoLP) but do need substantial privile These permissions are always needed to run the respective app. -| Permission | Renovate hosted app | Forking Renovate | Why | -| ----------------- | :-----------------: | :----------------: | ------------------------------------------------------------- | -| Dependabot alerts | `read` | `read` | Create vulnerability fix PRs | -| Administration | `read` | `read` | Read branch protections and to be able to assign teams to PRs | -| Metadata | `read` | `read` | Mandatory for all apps | -| Checks | `read` and `write` | not applicable | Read and write status checks | -| Code | `read` and `write` | `read` | Read for repository content and write for creating branches | -| Commit statuses | `read` and `write` | `read` and `write` | Read and write commit statuses for Renovate PRs | -| Issues | `read` and `write` | `read` and `write` | Create dependency dashboard or Config Warning issues | -| Pull Requests | `read` and `write` | `read` and `write` | Create update PRs | -| Workflows | `read` and `write` | not applicable | Explicit permission needed in order to update workflows | +| Permission | The Mend Renovate App | Forking Renovate | Why | +| ----------------- | :-------------------: | :----------------: | ------------------------------------------------------------- | +| Dependabot alerts | `read` | `read` | Create vulnerability fix PRs | +| Administration | `read` | `read` | Read branch protections and to be able to assign teams to PRs | +| Metadata | `read` | `read` | Mandatory for all apps | +| Checks | `read` and `write` | not applicable | Read and write status checks | +| Code | `read` and `write` | `read` | Read for repository content and write for creating branches | +| Commit statuses | `read` and `write` | `read` and `write` | Read and write commit statuses for Renovate PRs | +| Issues | `read` and `write` | `read` and `write` | Create dependency dashboard or Config Warning issues | +| Pull Requests | `read` and `write` | `read` and `write` | Create update PRs | +| Workflows | `read` and `write` | not applicable | Explicit permission needed in order to update workflows | ### User permissions Renovate can also request users's permission to the following resources. These permissions will be requested and authorized on an individual-user basis. -| Permission | Renovate hosted app | Forking Renovate | Why | -| ---------- | :-----------------: | :--------------: | -------------------------------------------------------- | -| email | `read` | not applicable | Per-user consent requested if logging into App dashboard | +| Permission | The Mend Renovate App | Forking Renovate | Why | +| ---------- | :-------------------: | :--------------: | -------------------------------------------------------- | +| email | `read` | not applicable | Per-user consent requested if logging into App dashboard | diff --git a/docs/usage/self-hosted-configuration.md b/docs/usage/self-hosted-configuration.md index 45fce42d3f..4757232ff2 100644 --- a/docs/usage/self-hosted-configuration.md +++ b/docs/usage/self-hosted-configuration.md @@ -823,7 +823,7 @@ For example: `:warning:` will be replaced with `⚠️`. You may need to set a `username` if you: - use the Bitbucket platform, or -- use the GitHub App with CLI (required) +- use a self-hosted GitHub App with CLI (required) If you're using a Personal Access Token (PAT) to authenticate then you should not set a `username`. diff --git a/docs/usage/troubleshooting.md b/docs/usage/troubleshooting.md index 62600b12b3..9966fc312a 100644 --- a/docs/usage/troubleshooting.md +++ b/docs/usage/troubleshooting.md @@ -7,9 +7,9 @@ Learn how to troubleshoot problems with Renovate, where to find the logging outp Renovate's debug-level logs are usually enough to help troubleshoot most problems. Where you can find the logs depends on how you're running Renovate. -### GitHub Hosted app +### The Mend Renovate App -Each pull request from Renovate has a link to the [Mend Developer Portal](https://developer.mend.io/) in the PR body text. +Each pull request from the Mend Renovate App has a link to the [Mend Developer Portal](https://developer.mend.io/) in the PR body text. The text you're looking for is: diff --git a/docs/usage/user-stories/swissquote.md b/docs/usage/user-stories/swissquote.md index 7c0d5e8e03..051a7b9395 100644 --- a/docs/usage/user-stories/swissquote.md +++ b/docs/usage/user-stories/swissquote.md @@ -179,7 +179,7 @@ Some features and options we enjoy: - Supports more than 70 [languages and package managers](https://docs.renovatebot.com/modules/manager/#supported-managers): Maven, Docker, npm, Docker Compose, Python - If you are using dependencies in a custom way, [there is a special regexManager](../configuration-options.md#regexmanagers) that allows you to transform patterns into dependencies -There is an [on-premise option](https://www.mend.io/free-developer-tools/renovate/on-premises/), but you can also have it as [an app on GitHub.com](https://github.com/marketplace/renovate). +There is an [on-premise option](https://www.mend.io/free-developer-tools/renovate/on-premises/), but you can also use [the Mend Renovate App](https://github.com/marketplace/renovate). On our side, we’re not using the on-premise but rather a custom scheduler using the open source Docker image. ## Some stats after two years with Renovate diff --git a/lib/modules/manager/bundler/readme.md b/lib/modules/manager/bundler/readme.md index 03cd0129d8..39548357a0 100644 --- a/lib/modules/manager/bundler/readme.md +++ b/lib/modules/manager/bundler/readme.md @@ -29,4 +29,4 @@ Instead of `token`, you may also supply `username` and `password` instead. If you don't want to commit raw secrets to your repository, either: - If self hosting, add the `hostRules` to your bot's configuration file rather than the repository's configuration file, or -- If using the hosted Mend Renovate app, make use of the [`encrypted`](https://docs.renovatebot.com/configuration-options/#encrypted) capability +- If using the Mend Renovate App, make use of the [`encrypted`](https://docs.renovatebot.com/configuration-options/#encrypted) capability diff --git a/lib/modules/manager/gomod/readme.md b/lib/modules/manager/gomod/readme.md index 62d912c31d..b84dbb933c 100644 --- a/lib/modules/manager/gomod/readme.md +++ b/lib/modules/manager/gomod/readme.md @@ -9,7 +9,7 @@ You might be interested in the following `postUpdateOptions`: 1. `gomodUpdateImportPaths` - if you'd like Renovate to update your source import paths on major updates before raising the PR 1. `gomodMassage` - to enable massaging of all `replace` statements prior to running `go` so that they will be ignored -When Renovate is running using `binarySource=docker` (such as in the hosted Mend Renovate app) then it will pick the latest compatible version of Go to run, i.e. the latest `1.x` release. +When Renovate is running using `binarySource=docker` (such as in the Mend Renovate App) then it will pick the latest compatible version of Go to run, i.e. the latest `1.x` release. Even if the `go.mod` has a version like `go 1.14`, Renovate will treat it as a `^1.14` constraint and not `=1.14`. Indirect updates are disabled by default. To enable them, add a package rule such as: diff --git a/readme.md b/readme.md index 6afc374ab3..e444b33be1 100644 --- a/readme.md +++ b/readme.md @@ -25,7 +25,7 @@ Multi-platform and multi-language. - Use ESLint-like shared config presets for ease of use and simplifying configuration (JSON format only) - Lock files are supported and updated in the same commit, including immediately resolving conflicts whenever PRs are merged - Get replacement PRs to migrate from a deprecated dependency to the community suggested replacement (npm packages only) -- Open source (installable via npm/Yarn or Docker Hub) so can be self-hosted or used via GitHub App +- Open source (installable via npm/Yarn or Docker Hub) so can be self-hosted or used via the Mend Renovate App ## Supported Platforms @@ -69,10 +69,9 @@ Get started with Renovate by checking out our [tutorial](https://github.com/reno ### GitHub -It's easiest to use the hosted Renovate app. -Install the [Renovate app](https://github.com/apps/renovate) now. - -[More details on the GitHub App installation](https://docs.renovatebot.com/getting-started/installing-onboarding/). +We recommend that you use the Mend Renovate App. +Install the [the Mend Renovate App](https://github.com/apps/renovate) now. +[More details on the Mend Renovate App installation](https://docs.renovatebot.com/getting-started/installing-onboarding/). ### Azure DevOps -- GitLab