- Creates or updates Pull Requests for each dependency that needs updating
-Creates or updates Pull Requests for each dependency that needs updating
- Discovers and processes all `package.json` files in repository (supports monorepo architecture)
-Discovers and processes all `package.json` files in repository (supports monorepo architecture)
- Supports multiple major versions per-dependency at once
-Supports multiple major versions per-dependency at once
- Configurable via file, environment, CLI, and `package.json`
-Configurable via file, environment, CLI, and `package.json`
- Supports `yarn.lock` and `package-lock.json` files
-Supports `yarn.lock` and `package-lock.json` files
- Supports GitHub and GitLab
-Supports GitHub and GitLab
- Open source and can be self-hosted
-Open source and can be self-hosted
## GitHub App
## GitHub App
...
@@ -26,59 +26,16 @@ $ npm install -g renovate
...
@@ -26,59 +26,16 @@ $ npm install -g renovate
You need to select a repository user for `renovate` to assume the identity of, and generate a Personal Access Token. It's recommended that you use a dedicated "bot" account for this to avoid user confusion.
You need to select a repository user for `renovate` to assume the identity of, and generate a Personal Access Token. It's recommended that you use a dedicated "bot" account for this to avoid user confusion.
You can find instructions for GitHub here (select "repo" permissions): https://help.github.com/articles/creating-an-access-token-for-command-line-use/
You can find instructions for GitHub [here](https://help.github.com/articles/creating-an-access-token-for-command-line-use/)(select"repo" permissions)
You can find instructions for GitLab here: https://docs.gitlab.com/ee/api/README.html#personal-access-tokens
You can find instructions for GitLab [here](https://docs.gitlab.com/ee/api/README.html#personal-access-tokens).
This token needs to be configured via file, environment variable, or CLI. See [docs/configuration.md](docs/configuration.md) for details.
This token needs to be configured via file, environment variable, or CLI. See [docs/configuration.md](docs/configuration.md) for details.
The simplest way is to expose it as `GITHUB_TOKEN` or `GITLAB_TOKEN`.
The simplest way is to expose it as `GITHUB_TOKEN` or `GITLAB_TOKEN`.
## Usage
## Usage
```
Run `renovate --help` for usage details.
$ node renovate --help
Usage: renovate [options] [repositories...]
Options:
-h, --help output usage information
--enabled [boolean] Enable or disable renovate
--onboarding [boolean] Require a Configuration PR first
--platform <string> Platform type of repository
--endpoint <string> Custom endpoint to use
--token <string> Repository Auth Token
--autodiscover [boolean] Autodiscover all repositories
--github-app-id <integer> GitHub App ID (enables GitHub App functionality if set)
Note: The first time you run `renovate` on a repository, it will not upgrade any dependencies. Instead, it will create a Pull Request (Merge Request if GitLab) called 'Configure Renovate' and commit a default `renovate.json` file to the repository. This PR can be close unmerged if the default settings are fine for you. Also, this behaviour can be disabled if you set the `onboarding` configuration option to `false` before running.
Note: The first time you run `renovate` on a repository, it will not upgrade any dependencies. Instead, it will create a Pull Request (Merge Request if GitLab) called 'Configure Renovate' and commit a default `renovate.json` file to the repository. This PR can be close unmerged if the default settings are fine for you. Also, this behaviour can be disabled if you set the `onboarding` configuration option to `false` before running.