Package io.github.cdklabs.projen.release

Interface GitHubReleasesPublishOptions

All Superinterfaces:

CommonPublishOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

GitHubReleasesPublishOptions.Jsii$Proxy

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

(experimental) Publishing options for GitHub releases.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static GitHubReleasesPublishOptions.Builder	builder()
String	getChangelogFile()	(experimental) The location of an .md file (relative to dist/) that includes the changelog for the release.
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 io.github.cdklabs.projen.release.CommonPublishOptions

getPostPublishSteps, getPrePublishSteps, getPublishTools

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
 

builder

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

Returns:

a GitHubReleasesPublishOptions.Builder of GitHubReleasesPublishOptions