Package io.github.cdklabs.projen.release

Interface GoPublishOptions

All Superinterfaces:

CommonPublishOptions, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

JsiiGoTarget, JsiiReleaseGo

All Known Implementing Classes:

GoPublishOptions.Jsii$Proxy, JsiiGoTarget.Jsii$Proxy, JsiiReleaseGo.Jsii$Proxy

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

(experimental) Options for Go releases.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static GoPublishOptions.Builder	builder()
default String	getGitBranch()	(experimental) Branch to push to.
default String	getGitCommitMessage()	(experimental) The commit message.
default String	getGithubDeployKeySecret()	(experimental) The name of the secret that includes a GitHub deploy key used to push to the GitHub repository.
default String	getGithubRepo()	(experimental) GitHub repository to push to.
default String	getGithubTokenSecret()	(experimental) The name of the secret that includes a personal GitHub access token used to push to the GitHub repository.
default Boolean	getGithubUseSsh()	(experimental) Use SSH to push to GitHub instead of a personal accses token.
default String	getGitUserEmail()	(experimental) The email to use in the release git commit.
default String	getGitUserName()	(experimental) The user name to use for the release git commit.

Methods inherited from interface io.github.cdklabs.projen.release.CommonPublishOptions

getPostPublishSteps, getPrePublishSteps, getPublishTools

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getGitBranch

@Stability(Experimental)
@Nullable
default String getGitBranch()

(experimental) Branch to push to.

Default: "main"

getGitCommitMessage

@Stability(Experimental)
@Nullable
default String getGitCommitMessage()

(experimental) The commit message.

Default: "chore(release): $VERSION"

getGithubDeployKeySecret

@Stability(Experimental)
@Nullable
default String getGithubDeployKeySecret()

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

getGithubRepo

@Stability(Experimental)
@Nullable
default String getGithubRepo()

(experimental) GitHub repository to push to.

Default: - derived from `moduleName`

getGithubTokenSecret

@Stability(Experimental)
@Nullable
default String getGithubTokenSecret()

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

getGithubUseSsh

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

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

Default: false

getGitUserEmail

@Stability(Experimental)
@Nullable
default String getGitUserEmail()

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

Default: "github-actions@github.com"

getGitUserName

@Stability(Experimental)
@Nullable
default String getGitUserName()

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

Default: "github-actions"

builder

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

Returns:

a GoPublishOptions.Builder of GoPublishOptions