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 for DependabotOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DependabotOptions.Builder	allow(List<? extends DependabotAllow> allow)	Sets the value of DependabotOptions.getAllow()
DependabotOptions.Builder	assignees(List<String> assignees)	Sets the value of DependabotOptions.getAssignees()
DependabotOptions	build()	Builds the configured instance.
DependabotOptions.Builder	groups(Map<String,? extends DependabotGroup> groups)	Sets the value of DependabotOptions.getGroups()
DependabotOptions.Builder	ignore(List<? extends DependabotIgnore> ignore)	Sets the value of DependabotOptions.getIgnore()
DependabotOptions.Builder	ignoreProjen(Boolean ignoreProjen)	Sets the value of DependabotOptions.getIgnoreProjen()
DependabotOptions.Builder	labels(List<String> labels)	Sets the value of DependabotOptions.getLabels()
DependabotOptions.Builder	openPullRequestsLimit(Number openPullRequestsLimit)	Sets the value of DependabotOptions.getOpenPullRequestsLimit()
DependabotOptions.Builder	registries(Map<String,? extends DependabotRegistry> registries)	Sets the value of DependabotOptions.getRegistries()
DependabotOptions.Builder	reviewers(List<String> reviewers)	Sets the value of DependabotOptions.getReviewers()
DependabotOptions.Builder	scheduleInterval(DependabotScheduleInterval scheduleInterval)	Sets the value of DependabotOptions.getScheduleInterval()
DependabotOptions.Builder	versioningStrategy(VersioningStrategy versioningStrategy)	Sets the value of DependabotOptions.getVersioningStrategy()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

allow

@Stability(Experimental)
public DependabotOptions.Builder allow(List<? extends DependabotAllow> allow)

Sets the value of DependabotOptions.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 of DependabotOptions.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 of DependabotOptions.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 of DependabotOptions.getIgnore()

Parameters:

ignore - You can use the ignore option 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 of DependabotOptions.getIgnoreProjen()

Parameters:

ignoreProjen - Ignores updates to projen. This is required since projen updates may cause changes in committed files and anti-tamper checks will fail.

Projen upgrades are covered through the ProjenUpgrade class.

Returns:

this

labels

@Stability(Experimental)
public DependabotOptions.Builder labels(List<String> labels)

Sets the value of DependabotOptions.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 of DependabotOptions.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 of DependabotOptions.getRegistries()

Parameters:

registries - Map of package registries to use.

Returns:

this

reviewers

@Stability(Experimental)
public DependabotOptions.Builder reviewers(List<String> reviewers)

Sets the value of DependabotOptions.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 of DependabotOptions.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 of DependabotOptions.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:

build in interface software.amazon.jsii.Builder<DependabotOptions>

Returns:

a new instance of DependabotOptions

Throws:

NullPointerException - if any required attribute was not provided