io.github.cdklabs.projen.release

Class ReleaseTrigger

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.release.ReleaseTrigger

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.929Z")
 @Stability(value=Experimental)
public class ReleaseTrigger
extends software.amazon.jsii.JsiiObject

(experimental) Used to manage release strategies.

This includes release and release artifact automation

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ReleaseTrigger(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ReleaseTrigger(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static ReleaseTrigger	continuous() (experimental) Creates a continuous release trigger.
String	getChangelogPath() (experimental) Project-level changelog file path.
String	getGitPushCommand() (experimental) Override git-push command used when releasing manually.
Boolean	getIsContinuous() (experimental) Whether or not this is a continuous release.
Boolean	getIsManual() (experimental) Whether or not this is a manual release trigger.
String	getSchedule() (experimental) Cron schedule for releases.
static ReleaseTrigger	manual() (experimental) Creates a manual release trigger.
static ReleaseTrigger	manual(ManualReleaseOptions options) (experimental) Creates a manual release trigger.
static ReleaseTrigger	scheduled(ScheduledReleaseOptions options) (experimental) Creates a scheduled release trigger.

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

ReleaseTrigger

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

ReleaseTrigger

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

Method Detail

continuous

@Stability(value=Experimental)
 @NotNull
public static ReleaseTrigger continuous()

(experimental) Creates a continuous release trigger.

Automated releases will occur on every commit.

manual

@Stability(value=Experimental)
 @NotNull
public static ReleaseTrigger manual(@Nullable
                                                                             ManualReleaseOptions options)

(experimental) Creates a manual release trigger.

Use this option if you want totally manual releases.

This will give you a release task that, in addition to the normal release activities will trigger a publish:git task. This task will handle project-level changelog management, release tagging, and pushing these artifacts to origin.

The command used for pushing can be customised by specifying gitPushCommand. Set to an empty string to disable pushing entirely.

Simply run yarn release to trigger a manual release.

Parameters:

options - release options.

manual

@Stability(value=Experimental)
 @NotNull
public static ReleaseTrigger manual()

(experimental) Creates a manual release trigger.

Use this option if you want totally manual releases.

This will give you a release task that, in addition to the normal release activities will trigger a publish:git task. This task will handle project-level changelog management, release tagging, and pushing these artifacts to origin.

The command used for pushing can be customised by specifying gitPushCommand. Set to an empty string to disable pushing entirely.

Simply run yarn release to trigger a manual release.

scheduled

@Stability(value=Experimental)
 @NotNull
public static ReleaseTrigger scheduled(@NotNull
                                                                                ScheduledReleaseOptions options)

(experimental) Creates a scheduled release trigger.

Automated releases will occur based on the provided cron schedule.

Parameters:

options - release options. This parameter is required.

getIsContinuous

@Stability(value=Experimental)
 @NotNull
public Boolean getIsContinuous()

(experimental) Whether or not this is a continuous release.

getIsManual

@Stability(value=Experimental)
 @NotNull
public Boolean getIsManual()

(experimental) Whether or not this is a manual release trigger.

getChangelogPath

@Stability(value=Experimental)
 @Nullable
public String getChangelogPath()

(experimental) Project-level changelog file path.

getGitPushCommand

@Stability(value=Experimental)
 @Nullable
public String getGitPushCommand()

(experimental) Override git-push command used when releasing manually.

Set to an empty string to disable pushing.

getSchedule

@Stability(value=Experimental)
 @Nullable
public String getSchedule()

(experimental) Cron schedule for releases.

Only defined if this is a scheduled release.

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 '0 17 * * *' - every day at 5 pm