Package io.github.cdklabs.projen.release

Class GoPublishOptions.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:

CommonPublishOptions, GoPublishOptions, software.amazon.jsii.JsiiSerializable

Enclosing interface:

GoPublishOptions

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

An implementation for GoPublishOptions

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.GoPublishOptions

GoPublishOptions.Builder, GoPublishOptions.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(GoPublishOptions.Builder builder)	Constructor that initializes the object based on literal property values passed by the GoPublishOptions.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	getGitBranch()	(experimental) Branch to push to.
String	getGitCommitMessage()	(experimental) The commit message.
String	getGithubDeployKeySecret()	(experimental) The name of the secret that includes a GitHub deploy key used to push to the GitHub repository.
String	getGithubRepo()	(experimental) GitHub repository to push to.
String	getGithubTokenSecret()	(experimental) The name of the secret that includes a personal GitHub access token used to push to the GitHub repository.
Boolean	getGithubUseSsh()	(experimental) Use SSH to push to GitHub instead of a personal accses token.
String	getGitUserEmail()	(experimental) The email to use in the release git commit.
String	getGitUserName()	(experimental) The user name to use for the release git commit.
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.
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(GoPublishOptions.Builder builder)

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

Method Detail

getGitBranch

public final String getGitBranch()

Description copied from interface: GoPublishOptions

(experimental) Branch to push to.

Default: "main"

Specified by:

getGitBranch in interface GoPublishOptions

getGitCommitMessage

public final String getGitCommitMessage()

Description copied from interface: GoPublishOptions

(experimental) The commit message.

Default: "chore(release): $VERSION"

Specified by:

getGitCommitMessage in interface GoPublishOptions

getGithubDeployKeySecret

public final String getGithubDeployKeySecret()

Description copied from interface: GoPublishOptions

(experimental) The name of the secret that includes a GitHub deploy key used to push to the GitHub repository.

Ignored if githubUseSsh is false.

Default: "GO_GITHUB_DEPLOY_KEY"

Specified by:

getGithubDeployKeySecret in interface GoPublishOptions

getGithubRepo

public final String getGithubRepo()

Description copied from interface: GoPublishOptions

(experimental) GitHub repository to push to.

Default: - derived from `moduleName`

Specified by:

getGithubRepo in interface GoPublishOptions

getGithubTokenSecret

public final String getGithubTokenSecret()

Description copied from interface: GoPublishOptions

(experimental) The name of the secret that includes a personal GitHub access token used to push to the GitHub repository.

Ignored if githubUseSsh is true.

Default: "GO_GITHUB_TOKEN"

Specified by:

getGithubTokenSecret in interface GoPublishOptions

getGithubUseSsh

public final Boolean getGithubUseSsh()

Description copied from interface: GoPublishOptions

(experimental) Use SSH to push to GitHub instead of a personal accses token.

Default: false

Specified by:

getGithubUseSsh in interface GoPublishOptions

getGitUserEmail

public final String getGitUserEmail()

Description copied from interface: GoPublishOptions

(experimental) The email to use in the release git commit.

Default: "github-actions@github.com"

Specified by:

getGitUserEmail in interface GoPublishOptions

getGitUserName

public final String getGitUserName()

Description copied from interface: GoPublishOptions

(experimental) The user name to use for the release git commit.

Default: "github-actions"

Specified by:

getGitUserName in interface GoPublishOptions

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