io.github.cdklabs.projen.github

Interface DependabotOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DependabotOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.757Z")
 @Stability(value=Experimental)
public interface DependabotOptions
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DependabotOptions.Builder A builder for DependabotOptions
static class	DependabotOptions.Jsii$Proxy An implementation for DependabotOptions

Method Summary

Modifier and Type	Method and Description
static DependabotOptions.Builder	builder()
default List<DependabotIgnore>	getIgnore() (experimental) You can use the `ignore` option to customize which dependencies are updated.
default Boolean	getIgnoreProjen() (experimental) Ignores updates to `projen`.
default List<String>	getLabels() (experimental) List of labels to apply to the created PR's.
default Map<String,DependabotRegistry>	getRegistries() (experimental) Map of package registries to use.
default DependabotScheduleInterval	getScheduleInterval() (experimental) How often to check for new versions and raise pull requests.
default VersioningStrategy	getVersioningStrategy() (experimental) The strategy to use when edits manifest and lock files.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getIgnore

@Stability(value=Experimental)
 @Nullable
default List<DependabotIgnore> getIgnore()

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

The ignore option supports the following options.

Default: []

getIgnoreProjen

@Stability(value=Experimental)
 @Nullable
default Boolean getIgnoreProjen()

(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

getLabels

@Stability(value=Experimental)
 @Nullable
default List<String> getLabels()

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

getRegistries

@Stability(value=Experimental)
 @Nullable
default Map<String,DependabotRegistry> getRegistries()

(experimental) Map of package registries to use.

Default: - use public registries

getScheduleInterval

@Stability(value=Experimental)
 @Nullable
default DependabotScheduleInterval getScheduleInterval()

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

Default: ScheduleInterval.DAILY

getVersioningStrategy

@Stability(value=Experimental)
 @Nullable
default VersioningStrategy getVersioningStrategy()

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

builder

@Stability(value=Experimental)
static DependabotOptions.Builder builder()

Returns:

a DependabotOptions.Builder of DependabotOptions