Package io.github.cdklabs.projen.release

Interface GitPublishOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

GitPublishOptions.Jsii$Proxy

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

(experimental) Publishing options for Git releases.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static GitPublishOptions.Builder	builder()
String	getChangelogFile()	(experimental) The location of an .md file (relative to dist/) that includes the changelog for the release.
default String	getGitBranch()	(experimental) Branch to push to.
default String	getGitPushCommand()	(experimental) Override git-push command.
default String	getProjectChangelogFile()	(experimental) The location of an .md file that includes the project-level changelog.
String	getReleaseTagFile()	(experimental) The location of a text file (relative to dist/) that contains the release tag.
String	getVersionFile()	(experimental) The location of a text file (relative to dist/) that contains the version number.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getChangelogFile

@Stability(Experimental)
@NotNull
String getChangelogFile()

(experimental) The location of an .md file (relative to dist/) that includes the changelog for the release.

Example:

 changelog.md
 

getReleaseTagFile

@Stability(Experimental)
@NotNull
String getReleaseTagFile()

(experimental) The location of a text file (relative to dist/) that contains the release tag.

Example:

 releasetag.txt
 

getVersionFile

@Stability(Experimental)
@NotNull
String getVersionFile()

(experimental) The location of a text file (relative to dist/) that contains the version number.

Example:

 version.txt
 

getGitBranch

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

(experimental) Branch to push to.

Default: "main"

getGitPushCommand

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

(experimental) Override git-push command.

Set to an empty string to disable pushing.

getProjectChangelogFile

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

(experimental) The location of an .md file that includes the project-level changelog.

builder

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

Returns:

a GitPublishOptions.Builder of GitPublishOptions