diff --git a/.github/ISSUE_TEMPLATE/3-Bug_report.md b/.github/ISSUE_TEMPLATE/3-Bug_report.md index a8d51c3da00079da0de5f392934f01b95bf1b101..b0d30866a6716960434a5980f0b25e5e65dbbb5c 100644 --- a/.github/ISSUE_TEMPLATE/3-Bug_report.md +++ b/.github/ISSUE_TEMPLATE/3-Bug_report.md @@ -4,13 +4,13 @@ about: You've found a bug with Renovate --- **What Renovate type are you using?** -Renovate CLI, Renovate GitHub App, or Renovate Pro? +Tell us if you're using the hosted App, or if you are self-hosted Renovate yourself. Platform too if you think it's relevant. **Describe the bug** A clear and concise description of what the bug is. **Did you see anything helpful in debug logs?** -If you are using the Renovate App, log into https://renovatebot.com/dashboard and locate the correct job log for when the problem occurred (e.g. when the PR was created). +If you are using the Renovate App, log into https://app.renovatebot.com/dashboard and locate the correct job log for when the problem occurred (e.g. when the PR was created). **To Reproduce** Steps to reproduce the behavior: diff --git a/docs/configuration.md b/docs/configuration.md index 02b7bf9d346ce07f37708937e18cc73124152b4a..41ce140402038d866897de724d76869794e2784e 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -70,6 +70,6 @@ any other settings above. ## Configuration Options -Please see [https://renovatebot.com/docs/configuration-options/](https://renovatebot.com/docs/configuration-options/) for a list of user-facing configuration options. +Please see [https://docs.renovatebot.com/configuration-options/](https://docs.renovatebot.com/configuration-options/) for a list of user-facing configuration options. For further options when running your own instance of Renovate, please see the full config definitions file at `lib/config/definitions.js`. diff --git a/docs/readme.md b/docs/readme.md index 26afeab9639247b7ca3a4c7a4b5f2dc26de01ff2..187ec69c6054e444e87f3d297be72a126def8e64 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -1,5 +1,5 @@ # Renovate Developer Docs -This directory is intended to provide documentation for developers/contributors on the Renovate project. For user-facing documentation - e.g. for how to configure Renovate as a user - please see https://renovatebot.com/docs +This directory is intended to provide documentation for developers/contributors on the Renovate project. For user-facing documentation - e.g. for how to configure Renovate as a user - please see https://docs.renovatebot.com If you would like to contribute to Renovate or get it running locally for some others reason, please check out [contributing.md](../.github/contributing.md) for steps on how to set up the project locally. diff --git a/docs/self-hosting.md b/docs/self-hosting.md index 1e0f817cdbfc30c57560a152c5c6557211df3115..ff24381a83eb7ea96699fd541160f1811b71641f 100644 --- a/docs/self-hosting.md +++ b/docs/self-hosting.md @@ -2,10 +2,7 @@ ## Open Source vs Commercial versions -Although Renovate is now best known as a "service" via the GitHub App, that service is actually running this same open source project, so you can get the same functionality if running it yourself. The version you see here in this repository can be cloned or `npm` installed in seconds and give you the same core functionality as in the app. - -There is also a commercially-licensed "Professional Edition" of Renovate available for GitHub Enterprise, that includes a stateful priority job queue, background scheduler and webhook listener. -For details and documentation on Renovate Pro, please visit [renovatebot.com/pro](https://renovatebot.com/pro). +Although Renovate is now best known as a "service" via the GitHub App, that service is actually running this same open source project, so you can get the same functionality if running it yourself. The version you see here in this repository can be cloned or `npm` installed in seconds and give you the same core functionality as in the app. The main feature that's missing is the responsiveness that comes from the app's use of a webhook listener (something not possible in a CLI tool). ## Installing Renovate OSS diff --git a/lib/config/app-strings.ts b/lib/config/app-strings.ts index 48f45622bfb67c65e9a14de9f5f1f264b4e3e76e..be445b4bca01ea88ac78ca8d60872fe39073d4b2 100644 --- a/lib/config/app-strings.ts +++ b/lib/config/app-strings.ts @@ -16,7 +16,7 @@ export const onboardingBranch = 'renovate/configure'; export const onboardingPrTitle = 'Configure Renovate'; export const urls = { - documentation: 'https://renovatebot.com/docs/', + documentation: 'https://docs.renovatebot.com/', help: 'https://github.com/renovatebot/config-help/issues', homepage: 'https://renovatebot.com', }; diff --git a/lib/manager/buildkite/readme.md b/lib/manager/buildkite/readme.md index 7ef74a953ecfdee267ec1d56b3e64133d2208d94..7103cf41e90035cc1b61ff8098d6104b8bae86c2 100644 --- a/lib/manager/buildkite/readme.md +++ b/lib/manager/buildkite/readme.md @@ -37,7 +37,7 @@ N/A --- -#### What [fileMatch](https://renovatebot.com/docs/configuration-options/#filematch) pattern(s) should be used? +#### What [fileMatch](https://docs.renovatebot.com/configuration-options/#filematch) pattern(s) should be used? `['buildkite\\.ya?ml', '\\.buildkite/.+\\.ya?ml$']` diff --git a/lib/manager/bundler/readme.md b/lib/manager/bundler/readme.md index 465750416b69c4a76c77249579bb0920fabb8759..8b945b10afdd07430b1121a8d4b2ab951f85a38e 100644 --- a/lib/manager/bundler/readme.md +++ b/lib/manager/bundler/readme.md @@ -30,7 +30,7 @@ Gemfile or gemspec --- -#### What [fileMatch](https://renovatebot.com/docs/configuration-options/#filematch) pattern(s) should be used? +#### What [fileMatch](https://docs.renovatebot.com/configuration-options/#filematch) pattern(s) should be used? ['(^|/)(Gemfile|.gemspec)$'] diff --git a/lib/manager/cargo/readme.md b/lib/manager/cargo/readme.md index 5775acb89c429ebf8f2730155ed87b58209ac87e..b5666e0cfe282c94ffe11aee230cfe0b6222950c 100644 --- a/lib/manager/cargo/readme.md +++ b/lib/manager/cargo/readme.md @@ -30,7 +30,7 @@ It uses exclusively `Cargo.toml` files. --- -#### What [fileMatch](https://renovatebot.com/docs/configuration-options/#filematch) pattern(s) should be used? +#### What [fileMatch](https://docs.renovatebot.com/configuration-options/#filematch) pattern(s) should be used? Cargo.toml diff --git a/lib/manager/cocoapods/readme.md b/lib/manager/cocoapods/readme.md index 3bbcf44566d83a2704d3574a8f2ec437bdaeac26..60fd16b958475d91882954d66d3ce2b267f0f73f 100644 --- a/lib/manager/cocoapods/readme.md +++ b/lib/manager/cocoapods/readme.md @@ -30,7 +30,7 @@ Podfile --- -#### What [fileMatch](https://renovatebot.com/docs/configuration-options/#filematch) pattern(s) should be used? +#### What [fileMatch](https://docs.renovatebot.com/configuration-options/#filematch) pattern(s) should be used? `['(^|/)Podfile$']` diff --git a/lib/manager/composer/readme.md b/lib/manager/composer/readme.md index cd926a69dbcfdd8385588639a851f4b16550ff75..14a82a24c07d530ed918093447199dff39e9cf1b 100644 --- a/lib/manager/composer/readme.md +++ b/lib/manager/composer/readme.md @@ -30,7 +30,7 @@ No, everyone uses Composer --- -#### What [fileMatch](https://renovatebot.com/docs/configuration-options/#filematch) pattern(s) should be used? +#### What [fileMatch](https://docs.renovatebot.com/configuration-options/#filematch) pattern(s) should be used? `['(^|/)([\\w-]*)composer.json$']` diff --git a/lib/manager/maven/readme.md b/lib/manager/maven/readme.md index d668550db9b7be1bd59454830dc8b7bc653c4359..adaeee5421aad02bcc9c72fea1bdd1ce303ca641 100644 --- a/lib/manager/maven/readme.md +++ b/lib/manager/maven/readme.md @@ -32,7 +32,7 @@ Gradle --- -#### What [fileMatch](https://renovatebot.com/docs/configuration-options/#filematch) pattern(s) should be used? +#### What [fileMatch](https://docs.renovatebot.com/configuration-options/#filematch) pattern(s) should be used? `['(^|/)([\\w-]*)pom.xml$']` diff --git a/lib/manager/poetry/readme.md b/lib/manager/poetry/readme.md index 310b4145012f63f9f04b0ed65ef2f4c98dfbb241..22048a3ec223dbbd93acf27b8ea6912653b2d06f 100644 --- a/lib/manager/poetry/readme.md +++ b/lib/manager/poetry/readme.md @@ -30,7 +30,7 @@ _pyproject.toml_ --- -#### What [fileMatch](https://renovatebot.com/docs/configuration-options/#filematch) pattern(s) should be used? +#### What [fileMatch](https://docs.renovatebot.com/configuration-options/#filematch) pattern(s) should be used? `(^|/)pyproject\\.toml$` diff --git a/lib/manager/pub/readme.md b/lib/manager/pub/readme.md index 0a71fccb350f64856914916a438dc37fdfa1212a..93ad0122311e5e419163c4d1e7074c919283d39d 100644 --- a/lib/manager/pub/readme.md +++ b/lib/manager/pub/readme.md @@ -30,7 +30,7 @@ _pubspec.yaml_ --- -#### What [fileMatch](https://renovatebot.com/docs/configuration-options/#filematch) pattern(s) should be used? +#### What [fileMatch](https://docs.renovatebot.com/configuration-options/#filematch) pattern(s) should be used? `(^|\/)pubspec\.yaml$` diff --git a/lib/manager/sbt/readme.md b/lib/manager/sbt/readme.md index 32162cc0235647434060d57a93d86234a1028a35..8deada36b55440c41eafff307cad7aa56776d1f0 100644 --- a/lib/manager/sbt/readme.md +++ b/lib/manager/sbt/readme.md @@ -31,7 +31,7 @@ As far as I know, there is 2 package files: --- -#### What [fileMatch](https://renovatebot.com/docs/configuration-options/#filematch) pattern(s) should be used? +#### What [fileMatch](https://docs.renovatebot.com/configuration-options/#filematch) pattern(s) should be used? `['build\\.sbt', 'plugins\\.sbt']` diff --git a/lib/workers/global/index.js b/lib/workers/global/index.js index 2e3ec31f0541ae657299296c4039db8b19bd233a..281e0e94e73894fc34c74dacd33e5d3b6814948f 100644 --- a/lib/workers/global/index.js +++ b/lib/workers/global/index.js @@ -28,23 +28,6 @@ async function start() { 'No repositories found - did you want to run with flag --autodiscover?' ); } - if ( - config.platform === 'github' && - config.endpoint && - !config.customPrFooter - ) { - config.prFooter = - 'Available now for Enterprise: [Renovate Pro](https://renovatebot.com/pro) with real-time webhook handling and priority job queue.'; - } - if ( - config.platform === 'gitlab' && - config.endpoint && - !config.endpoint.startsWith('https://gitlab.com/') && - !config.customPrFooter - ) { - config.prFooter = - 'Available now for GitLab: [Renovate Pro](https://renovatebot.com/pro) with real-time webhook handling and priority job queue.'; - } // Move global variables that we need to use later const importGlobals = ['prBanner', 'prFooter']; config.global = {}; diff --git a/readme.md b/readme.md index 02303eb592b8a6853b3eb1d649f5c3d06ba6bf07..7f00c3904111e49c7e6cf338e4ad5326684684f1 100644 --- a/readme.md +++ b/readme.md @@ -38,13 +38,13 @@ Renovate was released in 2017 and already is widely used in the developer commun The easiest way to use Renovate if you are hosted on GitHub.com or GitLab.com is to install the hosted Renovate app. For GitHub, go to [https://github.com/apps/renovate](https://github.com/apps/renovate) to install -it now. A GitHub Marketplace plan is required only for private repositories. [More details on the GitHub App installation](https://renovatebot.com/docs/install-github-app/). +it now. A GitHub Marketplace plan is required only for private repositories. [More details on the GitHub App installation](https://docs.renovatebot.com/install-github-app/). -For GitLab, log into [renovatebot.com/dashboard](https://renovatebot.com/dashboard) for a convenient way to add Renovate Bot to your project. Currently the GitLab app is free for both public and private repositories. [More details on the GitLab App installation](https://renovatebot.com/docs/install-gitlab-app/). +For GitLab, log into [app.renovatebot.com/dashboard](https://app.renovatebot.com/dashboard) for a convenient way to add Renovate Bot to your project. Currently the GitLab app is free for both public and private repositories. [More details on the GitLab App installation](https://docs.renovatebot.com/install-gitlab-app/). ## Configuration -Visit https://renovatebot.com/docs/ for documentation, and in particular https://renovatebot.com/docs/configuration-options/ for a list of configuration options. +Visit https://docs.renovatebot.com/ for documentation, and in particular https://docs.renovatebot.com/configuration-options/ for a list of configuration options. You can also raise an issue in https://github.com/renovatebot/config-help if you'd like to get your config reviewed or ask any questions. @@ -54,11 +54,11 @@ If you are not on github.com or gitlab.com, or you prefer to run your own instan - Install the `renovate` CLI tool from npmjs, run it on a schedule (e.g. using cron) - Run the `renovate/renovate` Docker Hub image (same content/versions as the CLI tool), run it on a schedule -- Use [Renovate Pro Edition](https://renovatebot.com/pro) available for GitHub Enterprise and GitLab, includes native scheduler +- Run the `renovate/renovate:slim` Docker Hub image if you only use package managers that don't need third party binaries (e.g. JS, Docker, Nuget, pip) ## Contributing -If you would like to contribute to Renovate or get a local copy running for some other reason, please see the instructions in [contributing.md](.github/contributing.md). +If you would like to contribute to Renovate or get a local copy running for some other reason, please see the instructions in [.github/contributing.md](.github/contributing.md). ## Security / Disclosure diff --git a/website/docs/config-presets.md b/website/docs/config-presets.md index dc6334b992028eacb54a0e15eacf193508107a4e..6d44b3ae2f1fad185a3a6e040350f6bfc07c3cc3 100644 --- a/website/docs/config-presets.md +++ b/website/docs/config-presets.md @@ -9,7 +9,7 @@ Renovate's "config presets" are a convenient way to distribute config that is re In short: -- Browse [Renovate's default presets](https://renovatebot.com/docs/presets-default/) to find any that are useful to you +- Browse [Renovate's default presets](https://docs.renovatebot.com/presets-default/) to find any that are useful to you - Publish your own if you wish to reuse them across repositories ## Goals of Preset Configs diff --git a/website/docs/configuration-options.md b/website/docs/configuration-options.md index 3a92b021a3a6e2c06c60a10b371b1ad2de57b47d..85d8a17dbc426f5007b7d4805c02a654d720e47a 100644 --- a/website/docs/configuration-options.md +++ b/website/docs/configuration-options.md @@ -263,7 +263,7 @@ Example: ## encrypted -See https://renovatebot.com/docs/private-modules for details on how this is used to encrypt npm tokens. +See https://docs.renovatebot.com/private-modules for details on how this is used to encrypt npm tokens. ## engines @@ -281,7 +281,7 @@ Be careful you know what you're doing with this option. The initial intended use ## extends -See https://renovatebot.com/docs/config-presets for details. +See https://docs.renovatebot.com/config-presets for details. ## fileMatch @@ -552,17 +552,17 @@ Add to this object if you wish to define rules that apply only to minor updates. Using this configuration option allows you to apply common configuration and policies across all Node.js version updates even if managed by different package managers (`npm`, `yarn`, etc.). -Check out our [Node.js documentation](https://renovatebot.com/docs/node) for a comprehensive explanation of how the `node` option can be used. +Check out our [Node.js documentation](https://docs.renovatebot.com/node) for a comprehensive explanation of how the `node` option can be used. ## npm ## npmToken -See https://renovatebot.com/docs/private-modules for details on how this is used. Typically you would encrypt it and put it inside the `encrypted` object. +See https://docs.renovatebot.com/private-modules for details on how this is used. Typically you would encrypt it and put it inside the `encrypted` object. ## npmrc -See https://renovatebot.com/docs/private-modules for details on how this is used. +See https://docs.renovatebot.com/private-modules for details on how this is used. ## nuget @@ -1022,7 +1022,7 @@ The `schedule` option allows you to define times of week or month for Renovate u The default value for `schedule` is "at any time", which is functionally the same as declaring a `null` schedule. i.e. Renovate will run on the repository around the clock. -The easiest way to define a schedule is to use a preset if one of them fits your requirements. See [Schedule presets](https://renovatebot.com/docs/presets-schedule/) for details and feel free to request a new one in the source repository if you think others would benefit from it too. +The easiest way to define a schedule is to use a preset if one of them fits your requirements. See [Schedule presets](https://docs.renovatebot.com/presets-schedule/) for details and feel free to request a new one in the source repository if you think others would benefit from it too. Otherwise, here are some text schedules that are known to work: @@ -1107,7 +1107,7 @@ This feature is added for people migrating from alternative services who are use Language support is limited to those listed below: -- **Node.js** - [Read our Node.js documentation](https://renovatebot.com/docs/node#configuring-support-policy) +- **Node.js** - [Read our Node.js documentation](https://docs.renovatebot.com/node#configuring-support-policy) ## suppressNotifications diff --git a/website/docs/docker.md b/website/docs/docker.md index 0572bd6d362d78ec7b84c264c7ec982a6ab70b27..201edddbeb668578a02e05ef2f98b0563caa6423 100644 --- a/website/docs/docker.md +++ b/website/docs/docker.md @@ -109,7 +109,7 @@ module.exports = { Alternatively, configure `DOCKER_USERNAME` and `DOCKER_PASSWORD` in env to achieve the same. -The above two approaches create an identical host rule in renovatebot. It is possible to add additional host rules following the [documentation](https://renovatebot.com/docs/configuration-options/#hostrules) +The above two approaches create an identical host rule in renovatebot. It is possible to add additional host rules following the [documentation](https://docs.renovatebot.com/configuration-options/#hostrules) For example if you have some images you host yourself and some images you pull from docker hub without logging in you can configure that like this: diff --git a/website/docs/golang.md b/website/docs/golang.md index a621b33a3a8abe868bd8e69d7e51e721cb022cf5..cb5797473fa5aacb5780f9a44228f4a749772b75 100644 --- a/website/docs/golang.md +++ b/website/docs/golang.md @@ -14,20 +14,20 @@ Renovate supports upgrading dependencies in `go.mod` files and their accompanyin 3. Renovate will resolve the dependency's source repository and check for semver tags if found. Otherwise commits and `v0.0.0-....` syntax will be used. 4. If an update was found, Renovate will update `go.mod` to the new value 5. Renovate will run `go get` to update the `go.sum` files. -6. If the user has enabled the option `gomodTidy` in the [`postUpdateOptions`](https://renovatebot.com/docs/configuration-options/#postupdateoptions) array, then Renovate will run `go mod tidy`, which itself can update `go.mod` and `go.sum`. +6. If the user has enabled the option `gomodTidy` in the [`postUpdateOptions`](https://docs.renovatebot.com/configuration-options/#postupdateoptions) array, then Renovate will run `go mod tidy`, which itself can update `go.mod` and `go.sum`. 7. `go mod vendor` will be run if vendored modules have been detected. 8. A PR will be created with `go.mod`,`go.sum`, and any updated vendored files updated in the one commit 9. If the source repository has either a "changelog" file or uses GitHub releases, then Release Notes for each version will be embedded in the generated PR. ## Enabling Go Modules Updating -Go Modules updating is on by default in Renovate Bot. To install Renovate Bot itself, either enable the [Renovate App](https://github.com/apps/renovate) on GitHub, or check out [Renovate OSS](https://github.com/renovatebot/renovate) or [Renovate Pro](https://renovatebot.com/pro) for self-hosted options. +Go Modules updating is on by default in Renovate Bot. To install Renovate Bot itself, either enable the [Renovate App](https://github.com/apps/renovate) on GitHub, or check out [Renovate OSS](https://github.com/renovatebot/renovate) for self-hosted. ## Technical Details #### Module Tidying -Go Modules tidying is not enabled by default, and so is opt-in via the [`postUpdateOptions`](https://renovatebot.com/docs/configuration-options/#postupdateoptions) config option. The reason for this is that a `go mod tidy` command may make changes to `go.mod` and `go.sum` that are completely unrelated to the updated module(s) in the PR, and so may be confusing to some users. +Go Modules tidying is not enabled by default, and so is opt-in via the [`postUpdateOptions`](https://docs.renovatebot.com/configuration-options/#postupdateoptions) config option. The reason for this is that a `go mod tidy` command may make changes to `go.mod` and `go.sum` that are completely unrelated to the updated module(s) in the PR, and so may be confusing to some users. #### Module Vendoring diff --git a/website/docs/install-gitlab-app.md b/website/docs/install-gitlab-app.md index a5a6f971ff3d3e5cd752bc0f6be7caa1b5e560b8..8c3558ab30b127ae17a1225a5c536d40e43bf0cc 100644 --- a/website/docs/install-gitlab-app.md +++ b/website/docs/install-gitlab-app.md @@ -15,7 +15,7 @@ Renovate runs as the user [@renovate-bot](https://gitlab.com/renovate-bot) on [g ### Dashboard -First, sign into the [Dashboard](https://renovatebot.com/dashboard) using GitLab OAuth. +First, sign into the [Dashboard](https://app.renovatebot.com/dashboard) using GitLab OAuth.  diff --git a/website/docs/php.md b/website/docs/php.md index b0e38031ebc9c578251a37d49d38272bb01a764a..2946dee24f0985f5427ce657592e75eba5a39e38 100644 --- a/website/docs/php.md +++ b/website/docs/php.md @@ -17,4 +17,4 @@ Renovate supports upgrading dependencies in PHP's `composer.json` files and thei ## Enabling -Either install the [Renovate App](https://github.com/apps/renovate) on GitHub, or check out [Renovate OSS](https://github.com/renovatebot/renovate) or [Renovate Pro](https://renovatebot.com/pro) for self-hosted options. +Either install the [Renovate App](https://github.com/apps/renovate) on GitHub, or check out [Renovate OSS](https://github.com/renovatebot/renovate) for self-hosted. diff --git a/website/docs/ruby.md b/website/docs/ruby.md index 96dadfa2b34b653778fba74478d857feb957172b..2d8e6dbae6a792ce5bf9a74caa0d0b51c5fe731f 100644 --- a/website/docs/ruby.md +++ b/website/docs/ruby.md @@ -17,7 +17,7 @@ Renovate supports upgrading dependencies in Bundler's `Gemfile`s and their accom ## Enabling -Either install the [Renovate App](https://github.com/apps/renovate) on GitHub, or check out [Renovate OSS](https://github.com/renovatebot/renovate) or [Renovate Pro](https://renovatebot.com/pro) for self-hosted options. +Either install the [Renovate App](https://github.com/apps/renovate) on GitHub, or check out [Renovate OSS](https://github.com/renovatebot/renovate) for self-hosted. Because Bundler is considered to be in alpha stage, it is not enabled by default. To opt-in to using it, `bundler.enabled` must be set to `true` in your config. If you are using the hosted Renovate App, then either: