Package io.github.cdklabs.projen.release

Class GitHubReleasesPublishOptions.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.release.GitHubReleasesPublishOptions.Jsii$Proxy

All Implemented Interfaces:

CommonPublishOptions, GitHubReleasesPublishOptions, software.amazon.jsii.JsiiSerializable

Enclosing interface:

GitHubReleasesPublishOptions

@Stability(Experimental)
@Internal
public static final class GitHubReleasesPublishOptions.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements GitHubReleasesPublishOptions

An implementation for GitHubReleasesPublishOptions

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface io.github.cdklabs.projen.release.GitHubReleasesPublishOptions

GitHubReleasesPublishOptions.Builder, GitHubReleasesPublishOptions.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(GitHubReleasesPublishOptions.Builder builder)	Constructor that initializes the object based on literal property values passed by the GitHubReleasesPublishOptions.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
String	getChangelogFile()	(experimental) The location of an .md file (relative to dist/) that includes the changelog for the release.
List<JobStep>	getPostPublishSteps()	(experimental) Steps to execute after executing the publishing command.
List<JobStep>	getPrePublishSteps()	(experimental) Steps to execute before executing the publishing command.
Tools	getPublishTools()	(experimental) Additional tools to install in the publishing job.
String	getReleaseTagFile()	(experimental) The location of a text file (relative to dist/) that contains the release tag.
String	getVersionFile()	(experimental) The location of a text file (relative to dist/) that contains the version number.
int	hashCode()

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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(GitHubReleasesPublishOptions.Builder builder)

Constructor that initializes the object based on literal property values passed by the GitHubReleasesPublishOptions.Builder.

Method Detail

getChangelogFile

public final String getChangelogFile()

Description copied from interface: GitHubReleasesPublishOptions

(experimental) The location of an .md file (relative to dist/) that includes the changelog for the release.

Example:

 changelog.md
 

Specified by:

getChangelogFile in interface GitHubReleasesPublishOptions

getReleaseTagFile

public final String getReleaseTagFile()

Description copied from interface: GitHubReleasesPublishOptions

(experimental) The location of a text file (relative to dist/) that contains the release tag.

Example:

 releasetag.txt
 

Specified by:

getReleaseTagFile in interface GitHubReleasesPublishOptions

getVersionFile

public final String getVersionFile()

Description copied from interface: GitHubReleasesPublishOptions

(experimental) The location of a text file (relative to dist/) that contains the version number.

Example:

 version.txt
 

Specified by:

getVersionFile in interface GitHubReleasesPublishOptions

getPostPublishSteps

public final List<JobStep> getPostPublishSteps()

Description copied from interface: CommonPublishOptions

(experimental) Steps to execute after executing the publishing command.

These can be used to add/update the release artifacts ot any other tasks needed.

Note that when using this in publishToGitHubReleases this will override steps added via addGitHubPostPublishingSteps.

Specified by:

getPostPublishSteps in interface CommonPublishOptions

getPrePublishSteps

public final List<JobStep> getPrePublishSteps()

Description copied from interface: CommonPublishOptions

(experimental) Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.

These steps are executed after dist/ has been populated with the build output.

Note that when using this in publishToGitHubReleases this will override steps added via addGitHubPrePublishingSteps.

Specified by:

getPrePublishSteps in interface CommonPublishOptions

getPublishTools

public final Tools getPublishTools()

Description copied from interface: CommonPublishOptions

(experimental) Additional tools to install in the publishing job.

Default: - no additional tools are installed

Specified by:

getPublishTools in interface CommonPublishOptions

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object