io.github.cdklabs.projen.github

Class Dependabot.Builder

java.lang.Object

io.github.cdklabs.projen.github.Dependabot.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Dependabot>

Enclosing class:

Dependabot

@Stability(value=Experimental)
public static final class Dependabot.Builder
extends Object
implements software.amazon.jsii.Builder<Dependabot>

(experimental) A fluent builder for Dependabot.

Method Summary

Modifier and Type	Method and Description
Dependabot	build()
static Dependabot.Builder	create(GitHub github)
Dependabot.Builder	ignore(List<? extends DependabotIgnore> ignore) (experimental) You can use the `ignore` option to customize which dependencies are updated.
Dependabot.Builder	ignoreProjen(Boolean ignoreProjen) (experimental) Ignores updates to `projen`.
Dependabot.Builder	labels(List<String> labels) (experimental) List of labels to apply to the created PR's.
Dependabot.Builder	registries(Map<String,? extends DependabotRegistry> registries) (experimental) Map of package registries to use.
Dependabot.Builder	scheduleInterval(DependabotScheduleInterval scheduleInterval) (experimental) How often to check for new versions and raise pull requests.
Dependabot.Builder	versioningStrategy(VersioningStrategy versioningStrategy) (experimental) The strategy to use when edits manifest and lock files.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static Dependabot.Builder create(GitHub github)

Parameters:

github - This parameter is required.

Returns:

a new instance of Dependabot.Builder.

ignore

@Stability(value=Experimental)
public Dependabot.Builder ignore(List<? extends DependabotIgnore> ignore)

(experimental) You can use the `ignore` option to customize which dependencies are updated.

The ignore option supports the following options.

Default: []

Parameters:

ignore - You can use the `ignore` option to customize which dependencies are updated. This parameter is required.

Returns:

this

ignoreProjen

@Stability(value=Experimental)
public Dependabot.Builder ignoreProjen(Boolean ignoreProjen)

(experimental) 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.

Default: true

Parameters:

ignoreProjen - Ignores updates to `projen`. This parameter is required.

Returns:

this

labels

@Stability(value=Experimental)
public Dependabot.Builder labels(List<String> labels)

(experimental) List of labels to apply to the created PR's.

Parameters:

labels - List of labels to apply to the created PR's. This parameter is required.

Returns:

this

registries

@Stability(value=Experimental)
public Dependabot.Builder registries(Map<String,? extends DependabotRegistry> registries)

(experimental) Map of package registries to use.

Default: - use public registries

Parameters:

registries - Map of package registries to use. This parameter is required.

Returns:

this

scheduleInterval

@Stability(value=Experimental)
public Dependabot.Builder scheduleInterval(DependabotScheduleInterval scheduleInterval)

(experimental) How often to check for new versions and raise pull requests.

Default: ScheduleInterval.DAILY

Parameters:

scheduleInterval - How often to check for new versions and raise pull requests. This parameter is required.

Returns:

this

versioningStrategy

@Stability(value=Experimental)
public Dependabot.Builder versioningStrategy(VersioningStrategy versioningStrategy)

(experimental) The strategy to use when edits manifest and lock files.

Default: VersioningStrategy.LOCKFILE_ONLY The default is to only update the lock file because package.json is controlled by projen and any outside updates will fail the build.

Parameters:

versioningStrategy - The strategy to use when edits manifest and lock files. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public Dependabot build()

Specified by:

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