mirror of https://github.com/renovatebot/renovate
feat: improve onboarding help
Adds mention of app author + how to recreate PR.pull/909/head v9.71.0
parent
2df69e1dc3
commit
a60748c5ec
|
@ -98,7 +98,7 @@ async function ensurePr(config, branchUpgrades) {
|
|||
|
||||
This is an onboarding PR to help you understand and configure Renovate before any regular Pull Requests begin. Once you close this Pull Request, Renovate will begin keeping your dependencies up-to-date via automated Pull Requests.
|
||||
|
||||
If you have any questions, try reading our [Getting Started Configuring Renovate](https://renovateapp.com/docs/getting-started/configure-renovate) page first.
|
||||
If you have any questions, try reading our [Getting Started Configuring Renovate](https://renovateapp.com/docs/getting-started/configure-renovate) page first, or feel free to ask the app author @rarkins a question in a comment below.
|
||||
|
||||
---
|
||||
|
||||
|
@ -117,6 +117,15 @@ Our [Configuration Docs](https://renovateapp.com/docs/) should be helpful if you
|
|||
You are not required to *merge* this Pull Request - Renovate will begin even if this "Configure Renovate" PR is closed *unmerged* and without a \`renovate.json\` file. However, it's recommended that you add configuration to your repository to ensure behaviour matches what you see described here.
|
||||
|
||||
Alternatively, you can add the same configuration settings into a "renovate" section of your \`package.json\` file(s) in this branch and delete the \`renovate.json\` from this PR. If you make these configuration changes in this branch then the results will be described in this PR after the next time Renovate runs.
|
||||
|
||||
#### Want to start over?
|
||||
|
||||
If you'd like Renovate to recreate this "Configure Renovate" PR from scratch - for example if your base branch has had substantial changes - then you need to:
|
||||
|
||||
1. (IMPORTANT) Rename this PR to something else, e.g. "Configure Renovate - old"
|
||||
2. Close the PR and delete the branch
|
||||
|
||||
If later on you ever wish to reconfigure Renovate then you can use this same trick of renaming the PR, but you'll also need to delete any \`renovate.json\` file too. You should then get a new "Configure Renovate" PR like this.
|
||||
`;
|
||||
if (warnings.length) {
|
||||
let prWarnings = `---\n\n### Warnings (${warnings.length})\n\n`;
|
||||
|
|
|
@ -9,7 +9,7 @@ Array [
|
|||
|
||||
This is an onboarding PR to help you understand and configure Renovate before any regular Pull Requests begin. Once you close this Pull Request, Renovate will begin keeping your dependencies up-to-date via automated Pull Requests.
|
||||
|
||||
If you have any questions, try reading our [Getting Started Configuring Renovate](https://renovateapp.com/docs/getting-started/configure-renovate) page first.
|
||||
If you have any questions, try reading our [Getting Started Configuring Renovate](https://renovateapp.com/docs/getting-started/configure-renovate) page first, or feel free to ask the app author @rarkins a question in a comment below.
|
||||
|
||||
---
|
||||
|
||||
|
@ -35,6 +35,15 @@ Our [Configuration Docs](https://renovateapp.com/docs/) should be helpful if you
|
|||
You are not required to *merge* this Pull Request - Renovate will begin even if this \\"Configure Renovate\\" PR is closed *unmerged* and without a \`renovate.json\` file. However, it's recommended that you add configuration to your repository to ensure behaviour matches what you see described here.
|
||||
|
||||
Alternatively, you can add the same configuration settings into a \\"renovate\\" section of your \`package.json\` file(s) in this branch and delete the \`renovate.json\` from this PR. If you make these configuration changes in this branch then the results will be described in this PR after the next time Renovate runs.
|
||||
|
||||
#### Want to start over?
|
||||
|
||||
If you'd like Renovate to recreate this \\"Configure Renovate\\" PR from scratch - for example if your base branch has had substantial changes - then you need to:
|
||||
|
||||
1. (IMPORTANT) Rename this PR to something else, e.g. \\"Configure Renovate - old\\"
|
||||
2. Close the PR and delete the branch
|
||||
|
||||
If later on you ever wish to reconfigure Renovate then you can use this same trick of renaming the PR, but you'll also need to delete any \`renovate.json\` file too. You should then get a new \\"Configure Renovate\\" PR like this.
|
||||
",
|
||||
true,
|
||||
],
|
||||
|
@ -50,7 +59,7 @@ Array [
|
|||
|
||||
This is an onboarding PR to help you understand and configure Renovate before any regular Pull Requests begin. Once you close this Pull Request, Renovate will begin keeping your dependencies up-to-date via automated Pull Requests.
|
||||
|
||||
If you have any questions, try reading our [Getting Started Configuring Renovate](https://renovateapp.com/docs/getting-started/configure-renovate) page first.
|
||||
If you have any questions, try reading our [Getting Started Configuring Renovate](https://renovateapp.com/docs/getting-started/configure-renovate) page first, or feel free to ask the app author @rarkins a question in a comment below.
|
||||
|
||||
---
|
||||
|
||||
|
@ -71,6 +80,15 @@ Our [Configuration Docs](https://renovateapp.com/docs/) should be helpful if you
|
|||
You are not required to *merge* this Pull Request - Renovate will begin even if this \\"Configure Renovate\\" PR is closed *unmerged* and without a \`renovate.json\` file. However, it's recommended that you add configuration to your repository to ensure behaviour matches what you see described here.
|
||||
|
||||
Alternatively, you can add the same configuration settings into a \\"renovate\\" section of your \`package.json\` file(s) in this branch and delete the \`renovate.json\` from this PR. If you make these configuration changes in this branch then the results will be described in this PR after the next time Renovate runs.
|
||||
|
||||
#### Want to start over?
|
||||
|
||||
If you'd like Renovate to recreate this \\"Configure Renovate\\" PR from scratch - for example if your base branch has had substantial changes - then you need to:
|
||||
|
||||
1. (IMPORTANT) Rename this PR to something else, e.g. \\"Configure Renovate - old\\"
|
||||
2. Close the PR and delete the branch
|
||||
|
||||
If later on you ever wish to reconfigure Renovate then you can use this same trick of renaming the PR, but you'll also need to delete any \`renovate.json\` file too. You should then get a new \\"Configure Renovate\\" PR like this.
|
||||
",
|
||||
true,
|
||||
],
|
||||
|
@ -85,7 +103,7 @@ Array [
|
|||
|
||||
This is an onboarding PR to help you understand and configure Renovate before any regular Pull Requests begin. Once you close this Pull Request, Renovate will begin keeping your dependencies up-to-date via automated Pull Requests.
|
||||
|
||||
If you have any questions, try reading our [Getting Started Configuring Renovate](https://renovateapp.com/docs/getting-started/configure-renovate) page first.
|
||||
If you have any questions, try reading our [Getting Started Configuring Renovate](https://renovateapp.com/docs/getting-started/configure-renovate) page first, or feel free to ask the app author @rarkins a question in a comment below.
|
||||
|
||||
---
|
||||
|
||||
|
@ -117,6 +135,15 @@ Our [Configuration Docs](https://renovateapp.com/docs/) should be helpful if you
|
|||
You are not required to *merge* this Pull Request - Renovate will begin even if this \\"Configure Renovate\\" PR is closed *unmerged* and without a \`renovate.json\` file. However, it's recommended that you add configuration to your repository to ensure behaviour matches what you see described here.
|
||||
|
||||
Alternatively, you can add the same configuration settings into a \\"renovate\\" section of your \`package.json\` file(s) in this branch and delete the \`renovate.json\` from this PR. If you make these configuration changes in this branch then the results will be described in this PR after the next time Renovate runs.
|
||||
|
||||
#### Want to start over?
|
||||
|
||||
If you'd like Renovate to recreate this \\"Configure Renovate\\" PR from scratch - for example if your base branch has had substantial changes - then you need to:
|
||||
|
||||
1. (IMPORTANT) Rename this PR to something else, e.g. \\"Configure Renovate - old\\"
|
||||
2. Close the PR and delete the branch
|
||||
|
||||
If later on you ever wish to reconfigure Renovate then you can use this same trick of renaming the PR, but you'll also need to delete any \`renovate.json\` file too. You should then get a new \\"Configure Renovate\\" PR like this.
|
||||
",
|
||||
true,
|
||||
]
|
||||
|
@ -130,7 +157,7 @@ Array [
|
|||
|
||||
This is an onboarding PR to help you understand and configure Renovate before any regular Pull Requests begin. Once you close this Pull Request, Renovate will begin keeping your dependencies up-to-date via automated Pull Requests.
|
||||
|
||||
If you have any questions, try reading our [Getting Started Configuring Renovate](https://renovateapp.com/docs/getting-started/configure-renovate) page first.
|
||||
If you have any questions, try reading our [Getting Started Configuring Renovate](https://renovateapp.com/docs/getting-started/configure-renovate) page first, or feel free to ask the app author @rarkins a question in a comment below.
|
||||
|
||||
---
|
||||
|
||||
|
@ -161,6 +188,15 @@ Our [Configuration Docs](https://renovateapp.com/docs/) should be helpful if you
|
|||
You are not required to *merge* this Pull Request - Renovate will begin even if this \\"Configure Renovate\\" PR is closed *unmerged* and without a \`renovate.json\` file. However, it's recommended that you add configuration to your repository to ensure behaviour matches what you see described here.
|
||||
|
||||
Alternatively, you can add the same configuration settings into a \\"renovate\\" section of your \`package.json\` file(s) in this branch and delete the \`renovate.json\` from this PR. If you make these configuration changes in this branch then the results will be described in this PR after the next time Renovate runs.
|
||||
|
||||
#### Want to start over?
|
||||
|
||||
If you'd like Renovate to recreate this \\"Configure Renovate\\" PR from scratch - for example if your base branch has had substantial changes - then you need to:
|
||||
|
||||
1. (IMPORTANT) Rename this PR to something else, e.g. \\"Configure Renovate - old\\"
|
||||
2. Close the PR and delete the branch
|
||||
|
||||
If later on you ever wish to reconfigure Renovate then you can use this same trick of renaming the PR, but you'll also need to delete any \`renovate.json\` file too. You should then get a new \\"Configure Renovate\\" PR like this.
|
||||
",
|
||||
true,
|
||||
]
|
||||
|
@ -175,7 +211,7 @@ Array [
|
|||
|
||||
This is an onboarding PR to help you understand and configure Renovate before any regular Pull Requests begin. Once you close this Pull Request, Renovate will begin keeping your dependencies up-to-date via automated Pull Requests.
|
||||
|
||||
If you have any questions, try reading our [Getting Started Configuring Renovate](https://renovateapp.com/docs/getting-started/configure-renovate) page first.
|
||||
If you have any questions, try reading our [Getting Started Configuring Renovate](https://renovateapp.com/docs/getting-started/configure-renovate) page first, or feel free to ask the app author @rarkins a question in a comment below.
|
||||
|
||||
---
|
||||
|
||||
|
@ -219,6 +255,15 @@ Our [Configuration Docs](https://renovateapp.com/docs/) should be helpful if you
|
|||
You are not required to *merge* this Pull Request - Renovate will begin even if this \\"Configure Renovate\\" PR is closed *unmerged* and without a \`renovate.json\` file. However, it's recommended that you add configuration to your repository to ensure behaviour matches what you see described here.
|
||||
|
||||
Alternatively, you can add the same configuration settings into a \\"renovate\\" section of your \`package.json\` file(s) in this branch and delete the \`renovate.json\` from this PR. If you make these configuration changes in this branch then the results will be described in this PR after the next time Renovate runs.
|
||||
|
||||
#### Want to start over?
|
||||
|
||||
If you'd like Renovate to recreate this \\"Configure Renovate\\" PR from scratch - for example if your base branch has had substantial changes - then you need to:
|
||||
|
||||
1. (IMPORTANT) Rename this PR to something else, e.g. \\"Configure Renovate - old\\"
|
||||
2. Close the PR and delete the branch
|
||||
|
||||
If later on you ever wish to reconfigure Renovate then you can use this same trick of renaming the PR, but you'll also need to delete any \`renovate.json\` file too. You should then get a new \\"Configure Renovate\\" PR like this.
|
||||
",
|
||||
true,
|
||||
],
|
||||
|
@ -234,7 +279,7 @@ Array [
|
|||
|
||||
This is an onboarding PR to help you understand and configure Renovate before any regular Pull Requests begin. Once you close this Pull Request, Renovate will begin keeping your dependencies up-to-date via automated Pull Requests.
|
||||
|
||||
If you have any questions, try reading our [Getting Started Configuring Renovate](https://renovateapp.com/docs/getting-started/configure-renovate) page first.
|
||||
If you have any questions, try reading our [Getting Started Configuring Renovate](https://renovateapp.com/docs/getting-started/configure-renovate) page first, or feel free to ask the app author @rarkins a question in a comment below.
|
||||
|
||||
---
|
||||
|
||||
|
@ -259,6 +304,15 @@ Our [Configuration Docs](https://renovateapp.com/docs/) should be helpful if you
|
|||
You are not required to *merge* this Pull Request - Renovate will begin even if this \\"Configure Renovate\\" PR is closed *unmerged* and without a \`renovate.json\` file. However, it's recommended that you add configuration to your repository to ensure behaviour matches what you see described here.
|
||||
|
||||
Alternatively, you can add the same configuration settings into a \\"renovate\\" section of your \`package.json\` file(s) in this branch and delete the \`renovate.json\` from this PR. If you make these configuration changes in this branch then the results will be described in this PR after the next time Renovate runs.
|
||||
|
||||
#### Want to start over?
|
||||
|
||||
If you'd like Renovate to recreate this \\"Configure Renovate\\" PR from scratch - for example if your base branch has had substantial changes - then you need to:
|
||||
|
||||
1. (IMPORTANT) Rename this PR to something else, e.g. \\"Configure Renovate - old\\"
|
||||
2. Close the PR and delete the branch
|
||||
|
||||
If later on you ever wish to reconfigure Renovate then you can use this same trick of renaming the PR, but you'll also need to delete any \`renovate.json\` file too. You should then get a new \\"Configure Renovate\\" PR like this.
|
||||
",
|
||||
true,
|
||||
],
|
||||
|
@ -274,7 +328,7 @@ Array [
|
|||
|
||||
This is an onboarding PR to help you understand and configure Renovate before any regular Pull Requests begin. Once you close this Pull Request, Renovate will begin keeping your dependencies up-to-date via automated Pull Requests.
|
||||
|
||||
If you have any questions, try reading our [Getting Started Configuring Renovate](https://renovateapp.com/docs/getting-started/configure-renovate) page first.
|
||||
If you have any questions, try reading our [Getting Started Configuring Renovate](https://renovateapp.com/docs/getting-started/configure-renovate) page first, or feel free to ask the app author @rarkins a question in a comment below.
|
||||
|
||||
---
|
||||
|
||||
|
@ -299,6 +353,15 @@ Our [Configuration Docs](https://renovateapp.com/docs/) should be helpful if you
|
|||
You are not required to *merge* this Pull Request - Renovate will begin even if this \\"Configure Renovate\\" PR is closed *unmerged* and without a \`renovate.json\` file. However, it's recommended that you add configuration to your repository to ensure behaviour matches what you see described here.
|
||||
|
||||
Alternatively, you can add the same configuration settings into a \\"renovate\\" section of your \`package.json\` file(s) in this branch and delete the \`renovate.json\` from this PR. If you make these configuration changes in this branch then the results will be described in this PR after the next time Renovate runs.
|
||||
|
||||
#### Want to start over?
|
||||
|
||||
If you'd like Renovate to recreate this \\"Configure Renovate\\" PR from scratch - for example if your base branch has had substantial changes - then you need to:
|
||||
|
||||
1. (IMPORTANT) Rename this PR to something else, e.g. \\"Configure Renovate - old\\"
|
||||
2. Close the PR and delete the branch
|
||||
|
||||
If later on you ever wish to reconfigure Renovate then you can use this same trick of renaming the PR, but you'll also need to delete any \`renovate.json\` file too. You should then get a new \\"Configure Renovate\\" PR like this.
|
||||
",
|
||||
true,
|
||||
],
|
||||
|
|
|
@ -84,7 +84,7 @@ describe('lib/workers/repository/onboarding', () => {
|
|||
});
|
||||
it('does not update pr', async () => {
|
||||
// prettier-ignore
|
||||
const existingPrBody = "Welcome to [Renovate](https://renovateapp.com)!\n\nThis is an onboarding PR to help you understand and configure Renovate before any regular Pull Requests begin. Once you close this Pull Request, Renovate will begin keeping your dependencies up-to-date via automated Pull Requests.\n\nIf you have any questions, try reading our [Getting Started Configuring Renovate](https://renovateapp.com/docs/getting-started/configure-renovate) page first.\n\n---\n\nIt looks like your repository dependencies are already up-to-date and no initial Pull Requests will be necessary.\n\nSometimes you may see multiple options for the same dependency (e.g. pinning in one branch and upgrading in another). This is expected and allows you the flexibility to choose which to merge first. Once you merge any PR, others will be updated or removed the next time Renovate runs.\n\nWould you like to change the way Renovate is upgrading your dependencies? Simply edit the `renovate.json` in this branch and this Pull Request description will be updated the next time Renovate runs.\n\nOur [Configuration Docs](https://renovateapp.com/docs/) should be helpful if you wish to modify any behaviour.\n\n---\n\n#### Don't want a `renovate.json` file?\n\nYou are not required to *merge* this Pull Request - Renovate will begin even if this \"Configure Renovate\" PR is closed *unmerged* and without a `renovate.json` file. However, it's recommended that you add configuration to your repository to ensure behaviour matches what you see described here.\n\nAlternatively, you can add the same configuration settings into a \"renovate\" section of your `package.json` file(s) in this branch and delete the `renovate.json` from this PR. If you make these configuration changes in this branch then the results will be described in this PR after the next time Renovate runs.\n";
|
||||
const existingPrBody = "Welcome to [Renovate](https://renovateapp.com)!\n\nThis is an onboarding PR to help you understand and configure Renovate before any regular Pull Requests begin. Once you close this Pull Request, Renovate will begin keeping your dependencies up-to-date via automated Pull Requests.\n\nIf you have any questions, try reading our [Getting Started Configuring Renovate](https://renovateapp.com/docs/getting-started/configure-renovate) page first, or feel free to ask the app author @rarkins a question in a comment below.\n\n---\n\nIt looks like your repository dependencies are already up-to-date and no initial Pull Requests will be necessary.\n\nSometimes you may see multiple options for the same dependency (e.g. pinning in one branch and upgrading in another). This is expected and allows you the flexibility to choose which to merge first. Once you merge any PR, others will be updated or removed the next time Renovate runs.\n\nWould you like to change the way Renovate is upgrading your dependencies? Simply edit the `renovate.json` in this branch and this Pull Request description will be updated the next time Renovate runs.\n\nOur [Configuration Docs](https://renovateapp.com/docs/) should be helpful if you wish to modify any behaviour.\n\n---\n\n#### Don't want a `renovate.json` file?\n\nYou are not required to *merge* this Pull Request - Renovate will begin even if this \"Configure Renovate\" PR is closed *unmerged* and without a `renovate.json` file. However, it's recommended that you add configuration to your repository to ensure behaviour matches what you see described here.\n\nAlternatively, you can add the same configuration settings into a \"renovate\" section of your `package.json` file(s) in this branch and delete the `renovate.json` from this PR. If you make these configuration changes in this branch then the results will be described in this PR after the next time Renovate runs.\n\n#### Want to start over?\n\nIf you'd like Renovate to recreate this \"Configure Renovate\" PR from scratch - for example if your base branch has had substantial changes - then you need to:\n\n1. (IMPORTANT) Rename this PR to something else, e.g. \"Configure Renovate - old\"\n2. Close the PR and delete the branch\n\nIf later on you ever wish to reconfigure Renovate then you can use this same trick of renaming the PR, but you'll also need to delete any `renovate.json` file too. You should then get a new \"Configure Renovate\" PR like this.\n";
|
||||
config.api.getBranchPr.mockReturnValueOnce({
|
||||
title: 'Configure Renovate',
|
||||
body: existingPrBody,
|
||||
|
|
Loading…
Reference in New Issue