io.github.cdklabs.projen.release

Class Release

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.release.Release

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.923Z")
 @Stability(value=Experimental)
public class Release
extends Component

(experimental) Manages releases (currently through GitHub workflows).

By default, no branches are released. To add branches, call addBranch().

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
	Release(GitHubProject project, ReleaseOptions options)
protected	Release(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Release(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	addBranch(String branch, BranchOptions options) (experimental) Adds a release branch.
void	addJobs(Map<String,Job> jobs) (experimental) Adds jobs to all release workflows.
List<String>	getBranches() (experimental) Retrieve all release branch names.
Publisher	getPublisher() (experimental) Package publisher.
void	preSynthesize() (experimental) Called before synthesis.

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

getProject, postSynthesize, synthesize

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

Release

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

Release

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

Release

@Stability(value=Experimental)
public Release(@NotNull
                                              GitHubProject project,
                                              @NotNull
                                              ReleaseOptions options)

Parameters:

project - This parameter is required.

options - This parameter is required.

Method Detail

addBranch

@Stability(value=Experimental)
public void addBranch(@NotNull
                                                     String branch,
                                                     @NotNull
                                                     BranchOptions options)

(experimental) Adds a release branch.

It is a git branch from which releases are published. If a project has more than one release branch, we require that majorVersion is also specified for the primary branch in order to ensure branches always release the correct version.

Parameters:

branch - The branch to monitor (e.g. `main`, `v2.x`). This parameter is required.

options - Branch definition. This parameter is required.

addJobs

@Stability(value=Experimental)
public void addJobs(@NotNull
                                                   Map<String,Job> jobs)

(experimental) Adds jobs to all release workflows.

Parameters:

jobs - The jobs to add (name => job). This parameter is required.

preSynthesize

@Stability(value=Experimental)
public void preSynthesize()

(experimental) Called before synthesis.

Overrides:

preSynthesize in class Component

getBranches

@Stability(value=Experimental)
 @NotNull
public List<String> getBranches()

(experimental) Retrieve all release branch names.

getPublisher

@Stability(value=Experimental)
 @NotNull
public Publisher getPublisher()

(experimental) Package publisher.