Package io.github.cdklabs.projen

Interface RenovatebotOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

RenovatebotOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:42.798Z")
@Stability(Experimental)
public interface RenovatebotOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options for Renovatebot.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RenovatebotOptions.Builder	builder()
default List<String>	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 Boolean	getMarker()
default Object	getOverrideConfig()
default List<String>	getScheduleInterval()	(experimental) How often to check for new versions and raise pull requests.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getIgnore

@Stability(Experimental)
@Nullable
default List<String> getIgnore()

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

The ignore option supports just package name.

Default: []

getIgnoreProjen

@Stability(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(Experimental)
@Nullable
default List<String> getLabels()

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

getMarker

@Stability(Experimental)
@Nullable
default Boolean getMarker()

getOverrideConfig

@Stability(Experimental)
@Nullable
default Object getOverrideConfig()

getScheduleInterval

@Stability(Experimental)
@Nullable
default List<String> getScheduleInterval()

(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"]

See Also:

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

builder

@Stability(Experimental)
static RenovatebotOptions.Builder builder()

Returns:

a RenovatebotOptions.Builder of RenovatebotOptions