Package io.github.cdklabs.projen.github
Class DependabotOptions.Builder
- java.lang.Object
-
- io.github.cdklabs.projen.github.DependabotOptions.Builder
-
- All Implemented Interfaces:
software.amazon.jsii.Builder<DependabotOptions>
- Enclosing interface:
- DependabotOptions
@Stability(Experimental) public static final class DependabotOptions.Builder extends Object implements software.amazon.jsii.Builder<DependabotOptions>
A builder forDependabotOptions
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
-
-
-
Method Detail
-
allow
@Stability(Experimental) public DependabotOptions.Builder allow(List<? extends DependabotAllow> allow)
Sets the value ofDependabotOptions.getAllow()- Parameters:
allow- https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#allow. Use the allow option to customize which dependencies are updated. This applies to both version and security updates.- Returns:
this
-
assignees
@Stability(Experimental) public DependabotOptions.Builder assignees(List<String> assignees)
Sets the value ofDependabotOptions.getAssignees()- Parameters:
assignees- Specify individual assignees or teams of assignees for all pull requests raised for a package manager.- Returns:
this
-
groups
@Stability(Experimental) public DependabotOptions.Builder groups(Map<String,? extends DependabotGroup> groups)
Sets the value ofDependabotOptions.getGroups()- Parameters:
groups- https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#groups. You can create groups to package dependency updates together into a single PR.- Returns:
this
-
ignore
@Stability(Experimental) public DependabotOptions.Builder ignore(List<? extends DependabotIgnore> ignore)
Sets the value ofDependabotOptions.getIgnore()- Parameters:
ignore- You can use theignoreoption to customize which dependencies are updated. The ignore option supports the following options.- Returns:
this
-
ignoreProjen
@Stability(Experimental) public DependabotOptions.Builder ignoreProjen(Boolean ignoreProjen)
Sets the value ofDependabotOptions.getIgnoreProjen()- Parameters:
ignoreProjen- Ignores updates toprojen. This is required since projen updates may cause changes in committed files and anti-tamper checks will fail.Projen upgrades are covered through the
ProjenUpgradeclass.- Returns:
this
-
labels
@Stability(Experimental) public DependabotOptions.Builder labels(List<String> labels)
Sets the value ofDependabotOptions.getLabels()- Parameters:
labels- List of labels to apply to the created PR's.- Returns:
this
-
openPullRequestsLimit
@Stability(Experimental) public DependabotOptions.Builder openPullRequestsLimit(Number openPullRequestsLimit)
Sets the value ofDependabotOptions.getOpenPullRequestsLimit()- Parameters:
openPullRequestsLimit- Sets the maximum of pull requests Dependabot opens for version updates. Dependabot will not open any new requests until some of those open requests are merged or closed.- Returns:
this
-
registries
@Stability(Experimental) public DependabotOptions.Builder registries(Map<String,? extends DependabotRegistry> registries)
Sets the value ofDependabotOptions.getRegistries()- Parameters:
registries- Map of package registries to use.- Returns:
this
-
reviewers
@Stability(Experimental) public DependabotOptions.Builder reviewers(List<String> reviewers)
Sets the value ofDependabotOptions.getReviewers()- Parameters:
reviewers- Specify individual reviewers or teams of reviewers for all pull requests raised for a package manager.- Returns:
this
-
scheduleInterval
@Stability(Experimental) public DependabotOptions.Builder scheduleInterval(DependabotScheduleInterval scheduleInterval)
Sets the value ofDependabotOptions.getScheduleInterval()- Parameters:
scheduleInterval- How often to check for new versions and raise pull requests.- Returns:
this
-
versioningStrategy
@Stability(Experimental) public DependabotOptions.Builder versioningStrategy(VersioningStrategy versioningStrategy)
Sets the value ofDependabotOptions.getVersioningStrategy()- Parameters:
versioningStrategy- The strategy to use when edits manifest and lock files.- Returns:
this
-
build
@Stability(Experimental) public DependabotOptions build()
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<DependabotOptions>- Returns:
- a new instance of
DependabotOptions - Throws:
NullPointerException- if any required attribute was not provided
-
-