Package io.github.cdklabs.projen

Class Renovatebot.Builder

java.lang.Object

io.github.cdklabs.projen.Renovatebot.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Renovatebot>

Enclosing class:

Renovatebot

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

(experimental) A fluent builder for Renovatebot.

Method Summary

Modifier and Type	Method	Description
Renovatebot	build()
static Renovatebot.Builder	create(Project project)
Renovatebot.Builder	ignore(List<String> ignore)	(experimental) You can use the ignore option to customize which dependencies are updated.
Renovatebot.Builder	ignoreProjen(Boolean ignoreProjen)	(experimental) Ignores updates to projen.
Renovatebot.Builder	labels(List<String> labels)	(experimental) List of labels to apply to the created PR's.
Renovatebot.Builder	marker(Boolean marker)
Renovatebot.Builder	overrideConfig(Object overrideConfig)
Renovatebot.Builder	scheduleInterval(List<String> scheduleInterval)	(experimental) How often to check for new versions and raise pull requests.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(Experimental)
public static Renovatebot.Builder create(Project project)

Parameters:

project - This parameter is required.

Returns:

a new instance of Renovatebot.Builder.

ignore

@Stability(Experimental)
public Renovatebot.Builder ignore(List<String> ignore)

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

The ignore option supports just package name.

Default: []

Parameters:

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

Returns:

this

ignoreProjen

@Stability(Experimental)
public Renovatebot.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(Experimental)
public Renovatebot.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

marker

@Stability(Experimental)
public Renovatebot.Builder marker(Boolean marker)

Parameters:

marker - This parameter is required.

Returns:

this

overrideConfig

@Stability(Experimental)
public Renovatebot.Builder overrideConfig(Object overrideConfig)

Parameters:

overrideConfig - This parameter is required.

Returns:

this

scheduleInterval

@Stability(Experimental)
public Renovatebot.Builder scheduleInterval(List<String> scheduleInterval)

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

Can be given in CRON or LATER format, and use multiple schedules (e.g. different for weekdays and weekends). Multiple rules are handles as OR.

Some normal scheduling values defined in enum RenovatebotScheduleInterval.

Default: ["at any time"]

Parameters:

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

Returns:

this

See Also:

https://docs.renovatebot.com/configuration-options/#schedule

build

@Stability(Experimental)
public Renovatebot build()

Specified by:

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

Returns:

a newly built instance of Renovatebot.