diff --git a/docs/usage/configuration-options.md b/docs/usage/configuration-options.md index d597344b6d8adf..971d7e46895a3c 100644 --- a/docs/usage/configuration-options.md +++ b/docs/usage/configuration-options.md @@ -392,7 +392,7 @@ Configure this option to `false` if you prefer Renovate to open a new issue when ## constraints -Constraints are used in package managers which use third party tools to update "artifacts" like lock files or checksum files. +Constraints are used in package managers which use third-party tools to update "artifacts" like lock files or checksum files. Typically, the constraint is detected automatically by Renovate from files within the repository and there is no need to manually configure it. Manually specifying constraints is supported for `ruby`, `bundler`, `composer`, `go`, `npm`, `yarn`, `pnpm`, `python`, `pipenv`, and `poetry`. diff --git a/docs/usage/examples/self-hosting.md b/docs/usage/examples/self-hosting.md index 97dc3f7ef80421..d3b37607cf0858 100644 --- a/docs/usage/examples/self-hosting.md +++ b/docs/usage/examples/self-hosting.md @@ -15,7 +15,7 @@ If you want to use these package managers to update your lockfiles, you must ens npm install -g yarn pnpm ``` -The same goes for any other third party binary tool like `gradle` or `poetry` - you need to make sure they are installed and the appropriate version before running Renovate. +The same goes for any other third-party binary tool like `gradle` or `poetry` - you need to make sure it is installed and the appropriate version before running Renovate. ### Docker diff --git a/docs/usage/getting-started/running.md b/docs/usage/getting-started/running.md index 7d125cefaa2530..a19079c12ef5f8 100644 --- a/docs/usage/getting-started/running.md +++ b/docs/usage/getting-started/running.md @@ -22,8 +22,8 @@ Self-hosting Renovate means that you are the "administrator" of the bot, which e Renovate's Open Source CLI is built and distributed as the npm package `renovate`. You can run this directly in any Node.js environment - even via `npx` - and it will process all the repositories it is configured with, before exiting. -When you install Renovate from npm it naturally does not come bundled with any third party tools or languages such as Ruby, Python, Composer, Bundler, Poetry, etc. -Therefore if you need Renovate to support any non-npm lock files like Bundler then you'll need to make sure all required third party tools are pre-installed in the same environment alongside Renovate before you run it. +When you install Renovate from npm it naturally does not come bundled with any third-party tools or languages such as Ruby, Python, Composer, Bundler, Poetry, etc. +Therefore if you need Renovate to support any non-npm lock files like Bundler then you'll need to make sure all required third-party tools are pre-installed in the same environment alongside Renovate before you run it. The `renovate` npm package is compatible with all of Renovate's supported platforms. diff --git a/docs/usage/modules/manager.md b/docs/usage/modules/manager.md index b53c1b2e762ce4..c91d3df65242f2 100644 --- a/docs/usage/modules/manager.md +++ b/docs/usage/modules/manager.md @@ -3,7 +3,7 @@ Renovate is based around the concept of "package managers", or "managers" for short. These range from traditional package managers like npm, Bundler and Composer through to less traditional concepts like CircleCI or Travis config files. -The goal of Renovate is to detect and maintain all third party dependencies in your repositories, through the use of managers. +The goal of Renovate is to detect and maintain all third-party dependencies in your repositories, through the use of managers. ## Supported Managers diff --git a/docs/usage/self-hosted-configuration.md b/docs/usage/self-hosted-configuration.md index 6283d86b00310a..294dd221287cb0 100644 --- a/docs/usage/self-hosted-configuration.md +++ b/docs/usage/self-hosted-configuration.md @@ -104,10 +104,10 @@ e.g. ## binarySource -Renovate often needs to use third party binaries in its PRs, e.g. `npm` to update `package-lock.json` or `go` to update `go.sum`. +Renovate often needs to use third-party binaries in its PRs, e.g. `npm` to update `package-lock.json` or `go` to update `go.sum`. By default, Renovate will use a child process to run such tools, so they need to be pre-installed before running Renovate and available in the path. -As an alternative, Renovate can use "sidecar" containers for third party tools. +As an alternative, Renovate can use "sidecar" containers for third-party tools. If configured, Renovate will use `docker run` to create containers such as Node.js or Python to run tools within as-needed. For this to work, `docker` needs to be installed and the Docker socket available to Renovate. diff --git a/lib/config/options/index.ts b/lib/config/options/index.ts index da9e1d713bbeba..230978b66338b2 100644 --- a/lib/config/options/index.ts +++ b/lib/config/options/index.ts @@ -262,7 +262,7 @@ const options: RenovateOptions[] = [ { name: 'binarySource', description: - 'Controls whether third party tools like npm or Gradle are called directly, or via Docker sidecar containers.', + 'Controls whether third-party tools like npm or Gradle are called directly, or via Docker sidecar containers.', globalOnly: true, type: 'string', allowedValues: ['global', 'docker'], diff --git a/readme.md b/readme.md index da0c383773edf5..0b1c0a45475a11 100644 --- a/readme.md +++ b/readme.md @@ -63,7 +63,7 @@ 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 -- Run the `renovate/renovate:slim` Docker Hub image if you only use package managers that don't need third party binaries (e.g. JavaScript, Docker, NuGet, pip) +- Run the `renovate/renovate:slim` Docker Hub image if you only use package managers that don't need third-party binaries (e.g. JavaScript, Docker, NuGet, pip) [More details on the self-hosting development](https://github.com/renovatebot/renovate/blob/main/docs/usage/getting-started/running.md).