Package io.github.cdklabs.projen.release
Class GitHubReleasesPublishOptions.Builder
- java.lang.Object
-
- io.github.cdklabs.projen.release.GitHubReleasesPublishOptions.Builder
-
- All Implemented Interfaces:
software.amazon.jsii.Builder<GitHubReleasesPublishOptions>
- Enclosing interface:
- GitHubReleasesPublishOptions
@Stability(Experimental) public static final class GitHubReleasesPublishOptions.Builder extends Object implements software.amazon.jsii.Builder<GitHubReleasesPublishOptions>
A builder forGitHubReleasesPublishOptions
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
-
-
-
Method Detail
-
changelogFile
@Stability(Experimental) public GitHubReleasesPublishOptions.Builder changelogFile(String changelogFile)
Sets the value ofGitHubReleasesPublishOptions.getChangelogFile()- Parameters:
changelogFile- The location of an .md file (relative todist/) that includes the changelog for the release. This parameter is required.- Returns:
this
-
releaseTagFile
@Stability(Experimental) public GitHubReleasesPublishOptions.Builder releaseTagFile(String releaseTagFile)
Sets the value ofGitHubReleasesPublishOptions.getReleaseTagFile()- Parameters:
releaseTagFile- The location of a text file (relative todist/) that contains the release tag. This parameter is required.- Returns:
this
-
versionFile
@Stability(Experimental) public GitHubReleasesPublishOptions.Builder versionFile(String versionFile)
Sets the value ofGitHubReleasesPublishOptions.getVersionFile()- Parameters:
versionFile- The location of a text file (relative todist/) that contains the version number. This parameter is required.- Returns:
this
-
postPublishSteps
@Stability(Experimental) public GitHubReleasesPublishOptions.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 GitHubReleasesPublishOptions.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 GitHubReleasesPublishOptions.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 GitHubReleasesPublishOptions build()
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<GitHubReleasesPublishOptions>- Returns:
- a new instance of
GitHubReleasesPublishOptions - Throws:
NullPointerException- if any required attribute was not provided
-
-