io.github.cdklabs.projen.release

Class Publisher

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.release.Publisher

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.920Z")
 @Stability(value=Experimental)
public class Publisher
extends Component

(experimental) Implements GitHub jobs for publishing modules to package managers.

Under the hood, it uses https://github.com/aws/jsii-release

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Publisher.Builder (experimental) A fluent builder for Publisher.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Publisher(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Publisher(software.amazon.jsii.JsiiObjectRef objRef)
	Publisher(Project project, PublisherOptions options)

Method Summary

Modifier and Type	Method and Description
String	getArtifactName()
String	getBuildJobId()
String	getCondition()
String	getJsiiReleaseVersion()
Task	publishToGit(GitPublishOptions options) (experimental) Publish to git.
void	publishToGitHubReleases(GitHubReleasesPublishOptions options) (experimental) Creates a GitHub Release.
void	publishToGo() (experimental) Adds a go publishing job.
void	publishToGo(GoPublishOptions options) (experimental) Adds a go publishing job.
void	publishToMaven() (experimental) Publishes artifacts from `java/**` to Maven.
void	publishToMaven(MavenPublishOptions options) (experimental) Publishes artifacts from `java/**` to Maven.
void	publishToNpm() (experimental) Publishes artifacts from `js/**` to npm.
void	publishToNpm(NpmPublishOptions options) (experimental) Publishes artifacts from `js/**` to npm.
void	publishToNuget() (experimental) Publishes artifacts from `dotnet/**` to NuGet Gallery.
void	publishToNuget(NugetPublishOptions options) (experimental) Publishes artifacts from `dotnet/**` to NuGet Gallery.
void	publishToPyPi() (experimental) Publishes wheel artifacts from `python` to PyPI.
void	publishToPyPi(PyPiPublishOptions options) (experimental) Publishes wheel artifacts from `python` to PyPI.

Methods inherited from class io.github.cdklabs.projen.Component

getProject, postSynthesize, preSynthesize, synthesize

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Publisher

protected Publisher(software.amazon.jsii.JsiiObjectRef objRef)

Publisher

protected Publisher(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Publisher

@Stability(value=Experimental)
public Publisher(@NotNull
                                                Project project,
                                                @NotNull
                                                PublisherOptions options)

Parameters:

project - This parameter is required.

options - This parameter is required.

Method Detail

publishToGit

@Stability(value=Experimental)
 @NotNull
public Task publishToGit(@NotNull
                                                                  GitPublishOptions options)

(experimental) Publish to git.

This includes generating a project-level changelog and release tags.

Parameters:

options - Options. This parameter is required.

publishToGitHubReleases

@Stability(value=Experimental)
public void publishToGitHubReleases(@NotNull
                                                                   GitHubReleasesPublishOptions options)

(experimental) Creates a GitHub Release.

Parameters:

options - Options. This parameter is required.

publishToGo

@Stability(value=Experimental)
public void publishToGo(@Nullable
                                                       GoPublishOptions options)

(experimental) Adds a go publishing job.

Parameters:

options - Options.

publishToGo

@Stability(value=Experimental)
public void publishToGo()

(experimental) Adds a go publishing job.

publishToMaven

@Stability(value=Experimental)
public void publishToMaven(@Nullable
                                                          MavenPublishOptions options)

(experimental) Publishes artifacts from `java/**` to Maven.

Parameters:

options - Options.

publishToMaven

@Stability(value=Experimental)
public void publishToMaven()

(experimental) Publishes artifacts from `java/**` to Maven.

publishToNpm

@Stability(value=Experimental)
public void publishToNpm(@Nullable
                                                        NpmPublishOptions options)

(experimental) Publishes artifacts from `js/**` to npm.

Parameters:

options - Options.

publishToNpm

@Stability(value=Experimental)
public void publishToNpm()

(experimental) Publishes artifacts from `js/**` to npm.

publishToNuget

@Stability(value=Experimental)
public void publishToNuget(@Nullable
                                                          NugetPublishOptions options)

(experimental) Publishes artifacts from `dotnet/**` to NuGet Gallery.

Parameters:

options - Options.

publishToNuget

@Stability(value=Experimental)
public void publishToNuget()

(experimental) Publishes artifacts from `dotnet/**` to NuGet Gallery.

publishToPyPi

@Stability(value=Experimental)
public void publishToPyPi(@Nullable
                                                         PyPiPublishOptions options)

(experimental) Publishes wheel artifacts from `python` to PyPI.

Parameters:

options - Options.

publishToPyPi

@Stability(value=Experimental)
public void publishToPyPi()

(experimental) Publishes wheel artifacts from `python` to PyPI.

getArtifactName

@Stability(value=Experimental)
 @NotNull
public String getArtifactName()

getBuildJobId

@Stability(value=Experimental)
 @NotNull
public String getBuildJobId()

getJsiiReleaseVersion

@Stability(value=Experimental)
 @NotNull
public String getJsiiReleaseVersion()

getCondition

@Stability(value=Experimental)
 @Nullable
public String getCondition()