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
60da06d5
Commit
60da06d5
authored
Mar 3, 2019
by
Rishabh Jain
Committed by
Rhys Arkins
Mar 3, 2019
Browse files
Options
Downloads
Patches
Plain Diff
docs: Fix typos in design decisions (#3296)
parent
69cdf2d1
No related branches found
No related tags found
No related merge requests found
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/design-decisions.md
+6
-7
6 additions, 7 deletions
docs/design-decisions.md
with
6 additions
and
7 deletions
docs/design-decisions.md
+
6
−
7
View file @
60da06d5
...
@@ -5,7 +5,7 @@ This file documents the design choices as well as configuration options.
...
@@ -5,7 +5,7 @@ This file documents the design choices as well as configuration options.
#### Stateless
#### Stateless
No state storage is needed on
`renovate`
or the source code repository apart
No state storage is needed on
`renovate`
or the source code repository apart
from what you see publicly (branches, Pull Requests). It therefore doesn't
from what you see publicly (branches, Pull Requests). It
,
therefore
,
doesn't
matter if you stop/restart the script and would even still work if you had it
matter if you stop/restart the script and would even still work if you had it
running from two different locations, as long as their configuration was the
running from two different locations, as long as their configuration was the
same.
same.
...
@@ -21,7 +21,7 @@ all operations are performed via the API.
...
@@ -21,7 +21,7 @@ all operations are performed via the API.
The script current processes repositories, package files, and dependencies
The script current processes repositories, package files, and dependencies
within them all synchronously.
within them all synchronously.
-
Greatly reduces chance of hitting simultaneous API rate limits
-
Greatly reduces
the
chance of hitting simultaneous API rate limits
-
Simplifies logging
-
Simplifies logging
Note: Initial queries to NPM are done in parallel.
Note: Initial queries to NPM are done in parallel.
...
@@ -41,11 +41,10 @@ are global (all repositories).
...
@@ -41,11 +41,10 @@ are global (all repositories).
## Automatic discovery of package.json locations
## Automatic discovery of package.json locations
D
efault behaviour is to auto-discover all
`package.json`
locations in a
The d
efault behaviour is to auto-discover all
`package.json`
locations in a
repository and process them all. Doing so means that "monorepos" are supported
repository and process them all. Doing so means that "monorepos" are supported
by default. This can be overridden by the configuration option
`includePaths`
,
by default. This can be overridden by the configuration option
`includePaths`
,
where you list the file paths manually (e.g. limit to just
`package.json`
in
where you list the file paths manually (e.g. limit to just
`package.json`
in the root of the repository).
root of repository).
## Separate Branches per dependency
## Separate Branches per dependency
...
@@ -63,7 +62,7 @@ the value `All`) and then all dependency updates will be in the same branch/PR.
...
@@ -63,7 +62,7 @@ the value `All`) and then all dependency updates will be in the same branch/PR.
## Separate Minor and Major PRs
## Separate Minor and Major PRs
`renovate`
will create multiple branches/PRs if both major and minor branch upgrades
`renovate`
will create multiple branches/PRs if both major and minor branch upgrades
are available. For example if the current example is 1.6.0 and upgrades to 1.7.0
are available. For example
,
if the current example is 1.6.0 and upgrades to 1.7.0
and 2.0.0 exist, then
`renovate`
will raise PRs for both the 1.x upgrade(s) and
and 2.0.0 exist, then
`renovate`
will raise PRs for both the 1.x upgrade(s) and
2.
x upgrade(s).
2.
x upgrade(s).
...
@@ -90,7 +89,7 @@ Note: Branch names are configurable using string templates.
...
@@ -90,7 +89,7 @@ Note: Branch names are configurable using string templates.
## Pull Request Recreation
## Pull Request Recreation
By default, the script does not create a new PR if it finds an identical one
By default, the script does not create a new PR if it finds an identical one
already closed. This allows users to close unwelcome upgrade PRs and worry about
already closed. This allows users to close unwelcome upgrade PRs and
not
worry about
them being recreated every run. Typically this is most useful for major
them being recreated every run. Typically this is most useful for major
upgrades. This option is configurable.
upgrades. This option is configurable.
...
...
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
sign in
to comment