Package io.github.cdklabs.projen.github

Class Dependabot

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.github.Dependabot

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.066Z")
@Stability(Experimental)
public class Dependabot
extends Component

(experimental) Defines dependabot configuration for node projects.

Since module versions are managed in projen, the versioning strategy will be configured to "lockfile-only" which means that only updates that can be done on the lockfile itself will be proposed.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Dependabot.Builder	(experimental) A fluent builder for Dependabot.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
	Dependabot(GitHub github)
	Dependabot(GitHub github, DependabotOptions options)
protected	Dependabot(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Dependabot(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	addAllow(String dependencyName)	(experimental) Allows a dependency from automatic updates.
void	addIgnore(String dependencyName, @NotNull String... versions)	(experimental) Ignores a dependency from automatic updates.
Object	getConfig()	(experimental) The raw dependabot configuration.
Boolean	getIgnoresProjen()	(experimental) Whether or not projen is also upgraded in this config,.

Methods inherited from class io.github.cdklabs.projen.Component

getProject, isComponent, postSynthesize, preSynthesize, synthesize

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Dependabot

protected Dependabot(software.amazon.jsii.JsiiObjectRef objRef)

Dependabot

protected Dependabot(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Dependabot

@Stability(Experimental)
public Dependabot(@NotNull
                  GitHub github,
                  @Nullable
                  DependabotOptions options)

Parameters:

github - This parameter is required.

options -

Dependabot

@Stability(Experimental)
public Dependabot(@NotNull
                  GitHub github)

Parameters:

github - This parameter is required.

Method Detail

addAllow

@Stability(Experimental)
public void addAllow(@NotNull
                     String dependencyName)

(experimental) Allows a dependency from automatic updates.

Parameters:

dependencyName - Use to allow updates for dependencies with matching names, optionally using * to match zero or more characters. This parameter is required.

addIgnore

@Stability(Experimental)
public void addIgnore(@NotNull
                      String dependencyName,
                      @NotNull
                      @NotNull String... versions)

(experimental) Ignores a dependency from automatic updates.

Parameters:

dependencyName - Use to ignore updates for dependencies with matching names, optionally using * to match zero or more characters. This parameter is required.

versions - Use to ignore specific versions or ranges of versions. This parameter is required.

getConfig

@Stability(Experimental)
@NotNull
public Object getConfig()

(experimental) The raw dependabot configuration.

See Also:

https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates

getIgnoresProjen

@Stability(Experimental)
@NotNull
public Boolean getIgnoresProjen()

(experimental) Whether or not projen is also upgraded in this config,.