Package io.github.cdklabs.projen.release

Class GoPublishOptions.Builder

java.lang.Object

io.github.cdklabs.projen.release.GoPublishOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<GoPublishOptions>

Enclosing interface:

GoPublishOptions

@Stability(Experimental)
public static final class GoPublishOptions.Builder
extends Object
implements software.amazon.jsii.Builder<GoPublishOptions>

A builder for GoPublishOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GoPublishOptions	build()	Builds the configured instance.
GoPublishOptions.Builder	gitBranch(String gitBranch)	Sets the value of GoPublishOptions.getGitBranch()
GoPublishOptions.Builder	gitCommitMessage(String gitCommitMessage)	Sets the value of GoPublishOptions.getGitCommitMessage()
GoPublishOptions.Builder	githubDeployKeySecret(String githubDeployKeySecret)	Sets the value of GoPublishOptions.getGithubDeployKeySecret()
GoPublishOptions.Builder	githubRepo(String githubRepo)	Sets the value of GoPublishOptions.getGithubRepo()
GoPublishOptions.Builder	githubTokenSecret(String githubTokenSecret)	Sets the value of GoPublishOptions.getGithubTokenSecret()
GoPublishOptions.Builder	githubUseSsh(Boolean githubUseSsh)	Sets the value of GoPublishOptions.getGithubUseSsh()
GoPublishOptions.Builder	gitUserEmail(String gitUserEmail)	Sets the value of GoPublishOptions.getGitUserEmail()
GoPublishOptions.Builder	gitUserName(String gitUserName)	Sets the value of GoPublishOptions.getGitUserName()
GoPublishOptions.Builder	postPublishSteps(List<? extends JobStep> postPublishSteps)	Sets the value of CommonPublishOptions.getPostPublishSteps()
GoPublishOptions.Builder	prePublishSteps(List<? extends JobStep> prePublishSteps)	Sets the value of CommonPublishOptions.getPrePublishSteps()
GoPublishOptions.Builder	publishTools(Tools publishTools)	Sets the value of CommonPublishOptions.getPublishTools()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

gitBranch

@Stability(Experimental)
public GoPublishOptions.Builder gitBranch(String gitBranch)

Sets the value of GoPublishOptions.getGitBranch()

Parameters:

gitBranch - Branch to push to.

Returns:

this

gitCommitMessage

@Stability(Experimental)
public GoPublishOptions.Builder gitCommitMessage(String gitCommitMessage)

Sets the value of GoPublishOptions.getGitCommitMessage()

Parameters:

gitCommitMessage - The commit message.

Returns:

this

githubDeployKeySecret

@Stability(Experimental)
public GoPublishOptions.Builder githubDeployKeySecret(String githubDeployKeySecret)

Sets the value of GoPublishOptions.getGithubDeployKeySecret()

Parameters:

githubDeployKeySecret - The name of the secret that includes a GitHub deploy key used to push to the GitHub repository. Ignored if githubUseSsh is false.

Returns:

this

githubRepo

@Stability(Experimental)
public GoPublishOptions.Builder githubRepo(String githubRepo)

Sets the value of GoPublishOptions.getGithubRepo()

Parameters:

githubRepo - GitHub repository to push to.

Returns:

this

githubTokenSecret

@Stability(Experimental)
public GoPublishOptions.Builder githubTokenSecret(String githubTokenSecret)

Sets the value of GoPublishOptions.getGithubTokenSecret()

Parameters:

githubTokenSecret - The name of the secret that includes a personal GitHub access token used to push to the GitHub repository. Ignored if githubUseSsh is true.

Returns:

this

githubUseSsh

@Stability(Experimental)
public GoPublishOptions.Builder githubUseSsh(Boolean githubUseSsh)

Sets the value of GoPublishOptions.getGithubUseSsh()

Parameters:

githubUseSsh - Use SSH to push to GitHub instead of a personal accses token.

Returns:

this

gitUserEmail

@Stability(Experimental)
public GoPublishOptions.Builder gitUserEmail(String gitUserEmail)

Sets the value of GoPublishOptions.getGitUserEmail()

Parameters:

gitUserEmail - The email to use in the release git commit.

Returns:

this

gitUserName

@Stability(Experimental)
public GoPublishOptions.Builder gitUserName(String gitUserName)

Sets the value of GoPublishOptions.getGitUserName()

Parameters:

gitUserName - The user name to use for the release git commit.

Returns:

this

postPublishSteps

@Stability(Experimental)
public GoPublishOptions.Builder postPublishSteps(List<? extends JobStep> postPublishSteps)

Sets the value of CommonPublishOptions.getPostPublishSteps()

Parameters:

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

Returns:

this

prePublishSteps

@Stability(Experimental)
public GoPublishOptions.Builder prePublishSteps(List<? extends JobStep> prePublishSteps)

Sets the value of CommonPublishOptions.getPrePublishSteps()

Parameters:

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

Returns:

this

publishTools

@Stability(Experimental)
public GoPublishOptions.Builder publishTools(Tools publishTools)

Sets the value of CommonPublishOptions.getPublishTools()

Parameters:

publishTools - Additional tools to install in the publishing job.

Returns:

this

build

@Stability(Experimental)
public GoPublishOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<GoPublishOptions>

Returns:

a new instance of GoPublishOptions

Throws:

NullPointerException - if any required attribute was not provided