Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
renovate
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
GitLab community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
SmartDataLab
public
applications
renovate
Commits
4c3f70d8
Unverified
Commit
4c3f70d8
authored
1 year ago
by
HonkingGoose
Committed by
GitHub
1 year ago
Browse files
Options
Downloads
Patches
Plain Diff
docs(configuration options): rewrite `keepUpdatedLabel` (#27703)
Co-authored-by:
Rhys Arkins
<
rhys@arkins.net
>
parent
54bca167
No related branches found
No related tags found
No related merge requests found
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
docs/usage/configuration-options.md
+8
-4
8 additions, 4 deletions
docs/usage/configuration-options.md
lib/config/options/index.ts
+1
-1
1 addition, 1 deletion
lib/config/options/index.ts
with
9 additions
and
5 deletions
docs/usage/configuration-options.md
+
8
−
4
View file @
4c3f70d8
...
...
@@ -2125,12 +2125,16 @@ We recommend that you use the `strict` mode, and enable the `dependencyDashboard
## keepUpdatedLabel
On supported platforms
it is possible to
add a label to a PR
to
recreate/rebase
it
when the branch falls
1 or more commits
behind
its
base branch.
On supported platforms
you may
add a label to a PR
so that Renovate
recreate
s
/rebase
s the PR
when the branch falls behind
the
base branch.
Adding the
`keepUpdatedLabel`
label to a PR makes Renovate behave as if
`rebaseWhen`
were set to
`behind-base-branch`
, but only for the given PR.
The label is not removed from the PR after the rebase is complete, unlike what happens with
`rebaseLabel`
.
Renovate does _not_ remove the label from the PR after it finishes rebasing.
This is different from the
`rebaseLabel`
option, where Renovate _removes_ the label from the PR after rebasing.
This can be useful when you have approved certain PRs and want to keep them updated until they are ready to be merged.
The setting
`keepUpdatedLabel`
is best used in conjunction with
`rebaseWhen`
set to the values of
`never`
or
`conflicted`
that limit rebasing.
`keepUpdatedLabel`
can be useful when you have approved certain PRs and want Renovate to keep the PRs up-to-date until you're ready to merge them.
The setting
`keepUpdatedLabel`
is best used in this scenario:
-
By default, you configure
`rebaseWhen`
to
`never`
or
`conflicted`
to reduce rebasing
-
Sometimes, you want Renovate to keep specific PRs up-to-date with their base branch (equivalent to
`rebaseWhen=behind-base-branch`
)
## labels
...
...
This diff is collapsed.
Click to expand it.
lib/config/options/index.ts
+
1
−
1
View file @
4c3f70d8
...
...
@@ -1766,7 +1766,7 @@ const options: RenovateOptions[] = [
{
name
:
'
keepUpdatedLabel
'
,
description
:
'
L
abel to request
Renovate bot always rebase to keep branch updated
.
'
,
'
If set, users can add this l
abel to
PRs to
request
they be kept updated with the base branch
.
'
,
type
:
'
string
'
,
supportedPlatforms
:
[
'
azure
'
,
'
gitea
'
,
'
github
'
,
'
gitlab
'
],
},
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment