Package io.github.cdklabs.projen.release

Class Publisher

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.release.Publisher

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.254Z")
@Stability(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/publib

Nested Class Summary

Nested Classes

Modifier and Type	Class	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

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static String	PUBLISH_GIT_TASK_NAME

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addGitHubPostPublishingSteps(@NotNull JobStep... steps)	(experimental) Adds post publishing steps for the GitHub release job.
void	addGitHubPrePublishingSteps(@NotNull JobStep... steps)	(experimental) Adds pre publishing steps for the GitHub release job.
String	getArtifactName()
String	getBuildJobId()
String	getCondition()
String	getJsiiReleaseVersion()	Deprecated. use publibVersion
String	getPublibVersion()
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, isComponent, postSynthesize, preSynthesize, synthesize

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

PUBLISH_GIT_TASK_NAME

@Stability(Experimental)
public static final String PUBLISH_GIT_TASK_NAME

Constructor Detail

Publisher

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

Publisher

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

Publisher

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

Parameters:

project - This parameter is required.

options - This parameter is required.

Method Detail

addGitHubPostPublishingSteps

@Stability(Experimental)
public void addGitHubPostPublishingSteps(@NotNull
                                         @NotNull JobStep... steps)

(experimental) Adds post publishing steps for the GitHub release job.

Parameters:

steps - The steps. This parameter is required.

addGitHubPrePublishingSteps

@Stability(Experimental)
public void addGitHubPrePublishingSteps(@NotNull
                                        @NotNull JobStep... steps)

(experimental) Adds pre publishing steps for the GitHub release job.

Parameters:

steps - The steps. This parameter is required.

publishToGit

@Stability(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(Experimental)
public void publishToGitHubReleases(@NotNull
                                    GitHubReleasesPublishOptions options)

(experimental) Creates a GitHub Release.

Parameters:

options - Options. This parameter is required.

publishToGo

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

(experimental) Adds a go publishing job.

Parameters:

options - Options.

publishToGo

@Stability(Experimental)
public void publishToGo()

(experimental) Adds a go publishing job.

publishToMaven

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

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

Parameters:

options - Options.

publishToMaven

@Stability(Experimental)
public void publishToMaven()

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

publishToNpm

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

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

Parameters:

options - Options.

publishToNpm

@Stability(Experimental)
public void publishToNpm()

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

publishToNuget

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

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

Parameters:

options - Options.

publishToNuget

@Stability(Experimental)
public void publishToNuget()

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

publishToPyPi

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

(experimental) Publishes wheel artifacts from python to PyPI.

Parameters:

options - Options.

publishToPyPi

@Stability(Experimental)
public void publishToPyPi()

(experimental) Publishes wheel artifacts from python to PyPI.

getArtifactName

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

getBuildJobId

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

getJsiiReleaseVersion

@Stability(Deprecated)
@Deprecated
@NotNull
public String getJsiiReleaseVersion()

Deprecated.

use publibVersion

getPublibVersion

@Stability(Experimental)
@NotNull
public String getPublibVersion()

getCondition

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