Skip to content
Snippets Groups Projects
Commit c1a0366f authored by Rhys Arkins's avatar Rhys Arkins
Browse files

Update docs

parent 8d289ac4
No related branches found
No related tags found
No related merge requests found
...@@ -73,6 +73,7 @@ $ node renovate --help ...@@ -73,6 +73,7 @@ $ node renovate --help
--labels <list> Labels to add to Pull Request --labels <list> Labels to add to Pull Request
--assignees <list> Assignees for Pull Request --assignees <list> Assignees for Pull Request
--reviewers <list> Requested reviewers for Pull Requests (GitHub only) --reviewers <list> Requested reviewers for Pull Requests (GitHub only)
--pin-versions [boolean] Convert ranged versions in package.json to pinned versions
--log-level <string> Logging level --log-level <string> Logging level
Examples: Examples:
...@@ -121,9 +122,10 @@ Obviously, you can't set repository or package file location with this method. ...@@ -121,9 +122,10 @@ Obviously, you can't set repository or package file location with this method.
| `rebaseStalePrs` | Rebase stale PRs (GitHub only) | boolean | `false` | `RENOVATE_REBASE_STALE_PRS` | `--rebase-stale-prs` | | `rebaseStalePrs` | Rebase stale PRs (GitHub only) | boolean | `false` | `RENOVATE_REBASE_STALE_PRS` | `--rebase-stale-prs` |
| `branchName` | Branch name template | string | `"renovate/{{depName}}-{{newVersionMajor}}.x"` | | | | `branchName` | Branch name template | string | `"renovate/{{depName}}-{{newVersionMajor}}.x"` | | |
| `commitMessage` | Commit message template | string | `"Update dependency {{depName}} to version {{newVersion}}"` | | | | `commitMessage` | Commit message template | string | `"Update dependency {{depName}} to version {{newVersion}}"` | | |
| `prTitle` | Pull Request title template | string | `"{{#if isPin}}Pin{{else}}Update{{/if}} dependency {{depName}} to version {{#if isMajor}}{{newVersionMajor}}.x{{else}}{{newVersion}}{{/if}}"` | | | | `prTitle` | Pull Request title template | string | `"{{#if isPin}}Pin{{else}}Update{{/if}} dependency {{depName}} to version {{#if isRange}}{{newVersion}}{{else}}{{#if isMajor}}{{newVersionMajor}}.x{{else}}{{newVersion}}{{/if}}{{/if}}"` | | |
| `prBody` | Pull Request body template | string | `"This Pull Request updates dependency {{depName}} from version `{{currentVersion}}` to `{{newVersion}}`\n\n{{changelog}}"` | | | | `prBody` | Pull Request body template | string | `"This Pull Request updates dependency {{depName}} from version `{{currentVersion}}` to `{{newVersion}}`\n\n{{changelog}}"` | | |
| `labels` | Labels to add to Pull Request | list | `[]` | `RENOVATE_LABELS` | `--labels` | | `labels` | Labels to add to Pull Request | list | `[]` | `RENOVATE_LABELS` | `--labels` |
| `assignees` | Assignees for Pull Request | list | `[]` | `RENOVATE_ASSIGNEES` | `--assignees` | | `assignees` | Assignees for Pull Request | list | `[]` | `RENOVATE_ASSIGNEES` | `--assignees` |
| `reviewers` | Requested reviewers for Pull Requests (GitHub only) | list | `[]` | `RENOVATE_REVIEWERS` | `--reviewers` | | `reviewers` | Requested reviewers for Pull Requests (GitHub only) | list | `[]` | `RENOVATE_REVIEWERS` | `--reviewers` |
| `pinVersions` | Convert ranged versions in package.json to pinned versions | boolean | `true` | `RENOVATE_PIN_VERSIONS` | `--pin-versions` |
| `logLevel` | Logging level | string | `"info"` | `LOG_LEVEL` | `--log-level` | | `logLevel` | Logging level | string | `"info"` | `LOG_LEVEL` | `--log-level` |
...@@ -55,6 +55,7 @@ $ node renovate --help ...@@ -55,6 +55,7 @@ $ node renovate --help
--labels <list> Labels to add to Pull Request --labels <list> Labels to add to Pull Request
--assignees <list> Assignees for Pull Request --assignees <list> Assignees for Pull Request
--reviewers <list> Requested reviewers for Pull Requests (GitHub only) --reviewers <list> Requested reviewers for Pull Requests (GitHub only)
--pin-versions [boolean] Convert ranged versions in package.json to pinned versions
--log-level <string> Logging level --log-level <string> Logging level
Examples: Examples:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment