renovate/renovate
1
0
Fork 0
mirror of https://github.com/renovatebot/renovate.git synced 2025-01-12 15:06:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

refactor: slim down onboarding PR description (#1274)

Browse source
This commit is contained in:
Rhys Arkins 2017-12-07 13:32:56 +01:00 committed by GitHub
parent c499790d94
commit 696aaa38af
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 5 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
lib/workers/repository/onboarding/pr/config-description.js
View file

@ -32,7 +32,7 @@ function getConfigDesc(config) {
}); });
desc += '\n'; desc += '\n';
desc += `Would you like to change the way Renovate is upgrading your dependencies?`; desc += `Would you like to change the way Renovate is upgrading your dependencies?`;
desc += ` Simply edit the \`renovate.json\` in this branch and this Pull Request description will be updated the next time Renovate runs. `; desc += ` Simply edit the \`renovate.json\` in this branch and this Pull Request description will be updated the next time Renovate runs. Try to use Config Presets (the \`extends\` array) when possible rather than raw config, as then this PR will be able to more accurately describe your settings.`;
desc += '\n\n---\n'; desc += '\n\n---\n';
return desc; return desc;
} }

17
lib/workers/repository/onboarding/pr/index.js
View file

@ -5,9 +5,9 @@ const { getPrList } = require('./pr-list');
const prTemplate = `Welcome to [Renovate](https://renovateapp.com)! const prTemplate = `Welcome to [Renovate](https://renovateapp.com)!
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. This is an onboarding PR to help you understand and configure Renovate before regular Pull Requests begin. Once you merge or close this Pull Request, Renovate will begin keeping your dependencies up-to-date.
If you have any questions, try reading our [Configuring Renovate](https://renovateapp.com/docs/getting-started/configure-renovate) help page first, or feel free to ask the app author @rarkins a question in a comment below. If you have any questions, try reading our [Docs](https://renovateapp.com/docs), particularly the Getting Started section. You can post questions in [our Config Help repository](https://github.com/renovateapp/config-help/issues) or @ the app author @rarkins in this PR and he'll probably see it.
--- ---
{{CONFIG}} {{CONFIG}}
@ -17,19 +17,6 @@ If you have any questions, try reading our [Configuring Renovate](https://renova
{{PRLIST}} {{PRLIST}}
--- ---
#### Don't want a \`renovate.json\` file?
Renovate will begin once this "Configure Renovate" PR is merged *or* closed, but it's recommended that you add the \`renovate.json\` 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.
#### 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.
`; `;
async function ensureOnboardingPr(config) { async function ensureOnboardingPr(config) {

4
test/workers/repository/onboarding/pr/__snapshots__/config-description.spec.js.snap
View file

@ -9,7 +9,7 @@ Based on the currently configured presets, Renovate will:
- Start dependency updates once this Configure Renovate PR is merged or closed - Start dependency updates once this Configure Renovate PR is merged or closed
- Run Renovate on following schedule: before 5am - Run Renovate on following schedule: before 5am
Would 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. Would 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. Try to use Config Presets (the \`extends\` array) when possible rather than raw config, as then this PR will be able to more accurately describe your settings.
--- ---
" "
@ -26,7 +26,7 @@ Based on the currently configured presets, Renovate will:
- description two - description two
- something else - something else
Would 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. Would 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. Try to use Config Presets (the \`extends\` array) when possible rather than raw config, as then this PR will be able to more accurately describe your settings.
--- ---
" "