io.github.cdklabs.projen.release

Class NpmPublishOptions.Builder

java.lang.Object

io.github.cdklabs.projen.release.NpmPublishOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<NpmPublishOptions>

Enclosing interface:

NpmPublishOptions

@Stability(value=Experimental)
public static final class NpmPublishOptions.Builder
extends Object
implements software.amazon.jsii.Builder<NpmPublishOptions>

A builder for NpmPublishOptions

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
NpmPublishOptions	build() Builds the configured instance.
NpmPublishOptions.Builder	codeArtifactOptions(CodeArtifactOptions codeArtifactOptions) Sets the value of NpmPublishOptions.getCodeArtifactOptions()
NpmPublishOptions.Builder	distTag(String distTag) Deprecated. Use `npmDistTag` for each release branch instead.
NpmPublishOptions.Builder	npmTokenSecret(String npmTokenSecret) Sets the value of NpmPublishOptions.getNpmTokenSecret()
NpmPublishOptions.Builder	registry(String registry) Sets the value of NpmPublishOptions.getRegistry()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

codeArtifactOptions

@Stability(value=Experimental)
public NpmPublishOptions.Builder codeArtifactOptions(CodeArtifactOptions codeArtifactOptions)

Sets the value of NpmPublishOptions.getCodeArtifactOptions()

Parameters:

codeArtifactOptions - Options for publishing npm package to AWS CodeArtifact.

Returns:

this

distTag

@Stability(value=Deprecated)
 @Deprecated
public NpmPublishOptions.Builder distTag(String distTag)

Deprecated. Use `npmDistTag` for each release branch instead.

Sets the value of NpmPublishOptions.getDistTag()

Parameters:

distTag - Tags can be used to provide an alias instead of version numbers. For example, a project might choose to have multiple streams of development and use a different tag for each stream, e.g., stable, beta, dev, canary.

By default, the latest tag is used by npm to identify the current version of a package, and npm install <pkg> (without any @<version> or @<tag> specifier) installs the latest tag. Typically, projects only use the latest tag for stable release versions, and use other tags for unstable versions such as prereleases.

The next tag is used by some projects to identify the upcoming version.

Returns:

this

npmTokenSecret

@Stability(value=Experimental)
public NpmPublishOptions.Builder npmTokenSecret(String npmTokenSecret)

Sets the value of NpmPublishOptions.getNpmTokenSecret()

Parameters:

npmTokenSecret - GitHub secret which contains the NPM token to use when publishing packages.

Returns:

this

registry

@Stability(value=Experimental)
public NpmPublishOptions.Builder registry(String registry)

Sets the value of NpmPublishOptions.getRegistry()

Parameters:

registry - The domain name of the npm package registry. To publish to GitHub Packages, set this value to "npm.pkg.github.com". In this if npmTokenSecret is not specified, it will default to GITHUB_TOKEN which means that you will be able to publish to the repository's package store. In this case, make sure repositoryUrl is correctly defined.

Returns:

this

build

@Stability(value=Experimental)
public NpmPublishOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<NpmPublishOptions>

Returns:

a new instance of NpmPublishOptions

Throws:

NullPointerException - if any required attribute was not provided