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 forGoPublishOptions
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
-
-
-
Method Detail
-
gitBranch
@Stability(Experimental) public GoPublishOptions.Builder gitBranch(String gitBranch)
Sets the value ofGoPublishOptions.getGitBranch()- Parameters:
gitBranch- Branch to push to.- Returns:
this
-
gitCommitMessage
@Stability(Experimental) public GoPublishOptions.Builder gitCommitMessage(String gitCommitMessage)
Sets the value ofGoPublishOptions.getGitCommitMessage()- Parameters:
gitCommitMessage- The commit message.- Returns:
this
-
githubDeployKeySecret
@Stability(Experimental) public GoPublishOptions.Builder githubDeployKeySecret(String githubDeployKeySecret)
Sets the value ofGoPublishOptions.getGithubDeployKeySecret()- Parameters:
githubDeployKeySecret- The name of the secret that includes a GitHub deploy key used to push to the GitHub repository. Ignored ifgithubUseSshisfalse.- Returns:
this
-
githubRepo
@Stability(Experimental) public GoPublishOptions.Builder githubRepo(String githubRepo)
Sets the value ofGoPublishOptions.getGithubRepo()- Parameters:
githubRepo- GitHub repository to push to.- Returns:
this
-
githubTokenSecret
@Stability(Experimental) public GoPublishOptions.Builder githubTokenSecret(String githubTokenSecret)
Sets the value ofGoPublishOptions.getGithubTokenSecret()- Parameters:
githubTokenSecret- The name of the secret that includes a personal GitHub access token used to push to the GitHub repository. Ignored ifgithubUseSshistrue.- Returns:
this
-
githubUseSsh
@Stability(Experimental) public GoPublishOptions.Builder githubUseSsh(Boolean githubUseSsh)
Sets the value ofGoPublishOptions.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 ofGoPublishOptions.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 ofGoPublishOptions.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 ofCommonPublishOptions.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
publishToGitHubReleasesthis will override steps added viaaddGitHubPostPublishingSteps.- Returns:
this
-
prePublishSteps
@Stability(Experimental) public GoPublishOptions.Builder prePublishSteps(List<? extends JobStep> prePublishSteps)
Sets the value ofCommonPublishOptions.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 afterdist/has been populated with the build output.Note that when using this in
publishToGitHubReleasesthis will override steps added viaaddGitHubPrePublishingSteps.- Returns:
this
-
publishTools
@Stability(Experimental) public GoPublishOptions.Builder publishTools(Tools publishTools)
Sets the value ofCommonPublishOptions.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:
buildin interfacesoftware.amazon.jsii.Builder<GoPublishOptions>- Returns:
- a new instance of
GoPublishOptions - Throws:
NullPointerException- if any required attribute was not provided
-
-