Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(config options): explain prCreation=approval #24949

Merged
merged 6 commits into from
Oct 3, 2023
Merged

docs(config options): explain prCreation=approval #24949

Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4cb50c2
docs(config options): explain `prCreation=approval`
HonkingGoose Oct 2, 2023
c0e115e
Apply maintainer suggestion
HonkingGoose Oct 2, 2023
3c7a90f
Update docs/usage/configuration-options.md
rarkins Oct 2, 2023
de071b0
Rewrite, do not use dep approval plus pr creation approval
HonkingGoose Oct 3, 2023
996ffd4
Update docs/usage/configuration-options.md
rarkins Oct 3, 2023
7b775ca
Update configuration-options.md
HonkingGoose Oct 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
35 changes: 22 additions & 13 deletions docs/usage/configuration-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3123,25 +3123,34 @@ This limit is enforced on a per-repository basis.

## prCreation

This setting tells Renovate when you would like it to raise PRs:
This setting tells Renovate _when_ to create PRs:

- `immediate` (default): Renovate will create PRs immediately after creating the corresponding branch
- `not-pending`: Renovate will wait until status checks have completed (passed or failed) before raising the PR
- `status-success`: Renovate won't raise PRs unless tests pass
- `immediate` (default): Renovate creates PRs immediately after creating the corresponding branch
- `not-pending`: Renovate waits until status checks have completed (passed or failed) before raising the PR
- `status-success`: Renovate only creates PRs when the the test pass
HonkingGoose marked this conversation as resolved.
Show resolved Hide resolved
- `approval`: Renovate creates branches for updates immediately, but creates the PR _after_ getting Dependency Dashboard approval

Renovate defaults to `immediate` but you might want to change this to `not-pending` instead.
When prCreation is set to `immediate`, you'll get a Pull Request and possible associated notification right away when a new update is available.
You'll have to wait until the checks have been performed, before you can decide if you want to merge the PR.

With prCreation set to `immediate`, you'll get a Pull Request and possible associated notification right away when a new update is available.
You'll have to wait until the checks have been performed, before you can decide if you want to merge the PR or not.

With prCreation set to `not-pending`, Renovate creates the PR only once all tests have passed or failed.
When prCreation is set to `not-pending`, Renovate creates the PR only once all tests have passed or failed.
When you get the PR notification, you can take action immediately, as you have the full test results.
If there are no checks associated, Renovate will create the PR once 24 hrs have elapsed since creation of the commit.
If there are no checks associated, Renovate will create the PR once 24 hours have elapsed since creation of the commit.

When prCreation is set to `status-success`, Renovate creates the PR only if all tests have passed.
rarkins marked this conversation as resolved.
Show resolved Hide resolved
When a branch remains without PR due to a failing test: select the corresponding PR from the Dependency Dashboard, and push your fixes to the branch.

With prCreation set to `status-success`, Renovate creates the PR only if/ once all tests have passed.
When prCreation is set to `approval`, Renovate creates the PR only when approved via the Dependency Dashboard.
Renovate still creates the _branch_ immediately.

For all cases of non-immediate PR creation, Renovate doesn't run instantly once tests complete.
Instead, Renovate can create the PR on its next run after relevant tests have completed, so there will be some delay.
<!-- prettier-ignore -->
!!! note
For all cases of non-immediate PR creation, Renovate doesn't run instantly once tests complete.
Instead, Renovate create the PR on its _next_ run after the relevant tests have completed, so there will be some delay.

<!-- prettier-ignore -->
!!! warning
If you set `prCreation=approval` you must _not_ use `dependencyDashboardApproval=true`!

## prFooter

Expand Down