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

chore: update definitions md file (#909)

parent a60748c5
No related branches found
No related tags found
No related merge requests found
...@@ -112,6 +112,7 @@ $ node renovate --help ...@@ -112,6 +112,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)
--npm <json> Configuration object for npm package.json renovation
--meteor <json> Configuration object for meteor package.js renovation --meteor <json> Configuration object for meteor package.js renovation
-h, --help output usage information -h, --help output usage information
Examples: Examples:
...@@ -518,7 +519,7 @@ Obviously, you can't set repository or package file location with this method. ...@@ -518,7 +519,7 @@ Obviously, you can't set repository or package file location with this method.
<td>Configuration to apply when an update type is patch. Only applies if `separatePatchReleases` is set to true</td> <td>Configuration to apply when an update type is patch. Only applies if `separatePatchReleases` is set to true</td>
<td>json</td> <td>json</td>
<td><pre>{ <td><pre>{
"branchName": "{{branchPrefix}}{{depName}}-{{newVersionMajor}}.{{newVersionMinor}}.x" "branchName": "{{branchPrefix}}{{depNameSanitized}}-{{newVersionMajor}}.{{newVersionMinor}}.x"
}</pre></td> }</pre></td>
<td>`RENOVATE_PATCH`</td> <td>`RENOVATE_PATCH`</td>
<td><td> <td><td>
...@@ -620,7 +621,7 @@ Obviously, you can't set repository or package file location with this method. ...@@ -620,7 +621,7 @@ Obviously, you can't set repository or package file location with this method.
<td>`branchName`</td> <td>`branchName`</td>
<td>Branch name template</td> <td>Branch name template</td>
<td>string</td> <td>string</td>
<td><pre>"{{branchPrefix}}{{depName}}-{{newVersionMajor}}.x"</pre></td> <td><pre>"{{branchPrefix}}{{depNameSanitized}}-{{newVersionMajor}}.x"</pre></td>
<td>`RENOVATE_BRANCH_NAME`</td> <td>`RENOVATE_BRANCH_NAME`</td>
<td><td> <td><td>
</tr> </tr>
...@@ -659,7 +660,8 @@ Obviously, you can't set repository or package file location with this method. ...@@ -659,7 +660,8 @@ Obviously, you can't set repository or package file location with this method.
"commitMessage": "Update lock file", "commitMessage": "Update lock file",
"prTitle": "Lock file maintenance", "prTitle": "Lock file maintenance",
"prBody": "This {{#if isGitHub}}Pull{{else}}Merge{{/if}} Request updates `package.json` lock files to use the latest dependency versions.\n\n{{#if schedule}}\n**Note**: This PR was created on a configured schedule (\"{{schedule}}\"{{#if timezone}} in timezone `{{timezone}}`{{/if}}) and will not receive updates outside those times.\n{{/if}}\n\n{{#if hasErrors}}\n\n---\n\n### Errors\n\nRenovate encountered some errors when processing your repository, so you are being notified here even if they do not directly apply to this PR.\n\n{{#each errors as |error|}}\n- `{{error.depName}}`: {{error.message}}\n{{/each}}\n{{/if}}\n\n{{#if hasWarnings}}\n\n---\n\n### Warnings\n\nPlease make sure the following warnings are safe to ignore:\n\n{{#each warnings as |warning|}}\n- `{{warning.depName}}`: {{warning.message}}\n{{/each}}\n{{/if}}\n\n---\n\nThis {{#if isGitHub}}PR{{else}}MR{{/if}} has been generated by [Renovate Bot](https://renovateapp.com).", "prBody": "This {{#if isGitHub}}Pull{{else}}Merge{{/if}} Request updates `package.json` lock files to use the latest dependency versions.\n\n{{#if schedule}}\n**Note**: This PR was created on a configured schedule (\"{{schedule}}\"{{#if timezone}} in timezone `{{timezone}}`{{/if}}) and will not receive updates outside those times.\n{{/if}}\n\n{{#if hasErrors}}\n\n---\n\n### Errors\n\nRenovate encountered some errors when processing your repository, so you are being notified here even if they do not directly apply to this PR.\n\n{{#each errors as |error|}}\n- `{{error.depName}}`: {{error.message}}\n{{/each}}\n{{/if}}\n\n{{#if hasWarnings}}\n\n---\n\n### Warnings\n\nPlease make sure the following warnings are safe to ignore:\n\n{{#each warnings as |warning|}}\n- `{{warning.depName}}`: {{warning.message}}\n{{/each}}\n{{/if}}\n\n---\n\nThis {{#if isGitHub}}PR{{else}}MR{{/if}} has been generated by [Renovate Bot](https://renovateapp.com).",
"schedule": ["before 5am on monday"] "schedule": ["before 5am on monday"],
"groupName": null
}</pre></td> }</pre></td>
<td>`RENOVATE_LOCK_FILE_MAINTENANCE`</td> <td>`RENOVATE_LOCK_FILE_MAINTENANCE`</td>
<td><td> <td><td>
...@@ -726,6 +728,14 @@ Obviously, you can't set repository or package file location with this method. ...@@ -726,6 +728,14 @@ Obviously, you can't set repository or package file location with this method.
<td>`RENOVATE_REVIEWERS`</td> <td>`RENOVATE_REVIEWERS`</td>
<td>`--reviewers`<td> <td>`--reviewers`<td>
</tr> </tr>
<tr>
<td>`npm`</td>
<td>Configuration object for npm package.json renovation</td>
<td>json</td>
<td><pre>{}</pre></td>
<td>`RENOVATE_NPM`</td>
<td>`--npm`<td>
</tr>
<tr> <tr>
<td>`meteor`</td> <td>`meteor`</td>
<td>Configuration object for meteor package.js renovation</td> <td>Configuration object for meteor package.js renovation</td>
...@@ -740,7 +750,7 @@ Obviously, you can't set repository or package file location with this method. ...@@ -740,7 +750,7 @@ Obviously, you can't set repository or package file location with this method.
<td>json</td> <td>json</td>
<td><pre>{ <td><pre>{
"enabled": false, "enabled": false,
"branchName": "{{branchPrefix}}docker-{{depName}}-{{currentTag}}", "branchName": "{{branchPrefix}}docker-{{depNameSanitized}}-{{currentTag}}",
"commitMessage": "Update {{depName}}:{{currentTag}} digest", "commitMessage": "Update {{depName}}:{{currentTag}} digest",
"prTitle": "Update Dockerfile image {{depName}}@{{currentTag}} digest", "prTitle": "Update Dockerfile image {{depName}}@{{currentTag}} digest",
"prBody": "This {{#if isGitHub}}Pull{{else}}Merge{{/if}} Request updates Docker base image `{{depName}}@{{currentTag}}` to the latest digest (`{{newDigest}}`).\n\n{{#if schedule}}\n**Note**: This PR was created on a configured schedule (\"{{schedule}}\"{{#if timezone}} in timezone `{{timezone}}`{{/if}}) and will not receive updates outside those times.\n{{/if}}\n\n{{#if hasErrors}}\n\n---\n\n### Errors\n\nRenovate encountered some errors when processing your repository, so you are being notified here even if they do not directly apply to this PR.\n\n{{#each errors as |error|}}\n- `{{error.depName}}`: {{error.message}}\n{{/each}}\n{{/if}}\n\n{{#if hasWarnings}}\n\n---\n\n### Warnings\n\nPlease make sure the following warnings are safe to ignore:\n\n{{#each warnings as |warning|}}\n- `{{warning.depName}}`: {{warning.message}}\n{{/each}}\n{{/if}}\n\n---\n\nThis {{#if isGitHub}}PR{{else}}MR{{/if}} has been generated by [Renovate Bot](https://renovateapp.com).", "prBody": "This {{#if isGitHub}}Pull{{else}}Merge{{/if}} Request updates Docker base image `{{depName}}@{{currentTag}}` to the latest digest (`{{newDigest}}`).\n\n{{#if schedule}}\n**Note**: This PR was created on a configured schedule (\"{{schedule}}\"{{#if timezone}} in timezone `{{timezone}}`{{/if}}) and will not receive updates outside those times.\n{{/if}}\n\n{{#if hasErrors}}\n\n---\n\n### Errors\n\nRenovate encountered some errors when processing your repository, so you are being notified here even if they do not directly apply to this PR.\n\n{{#each errors as |error|}}\n- `{{error.depName}}`: {{error.message}}\n{{/each}}\n{{/if}}\n\n{{#if hasWarnings}}\n\n---\n\n### Warnings\n\nPlease make sure the following warnings are safe to ignore:\n\n{{#each warnings as |warning|}}\n- `{{warning.depName}}`: {{warning.message}}\n{{/each}}\n{{/if}}\n\n---\n\nThis {{#if isGitHub}}PR{{else}}MR{{/if}} has been generated by [Renovate Bot](https://renovateapp.com).",
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment