Package io.github.cdklabs.projen.release

Interface NpmPublishOptions

All Superinterfaces:

CommonPublishOptions, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

JsiiReleaseNpm

All Known Implementing Classes:

JsiiReleaseNpm.Jsii$Proxy, NpmPublishOptions.Jsii$Proxy

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

(experimental) Options for npm release.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static NpmPublishOptions.Builder	builder()
default CodeArtifactOptions	getCodeArtifactOptions()	(experimental) Options for publishing npm package to AWS CodeArtifact.
default String	getDistTag()	Deprecated. Use npmDistTag for each release branch instead.
default Boolean	getNpmProvenance()	(experimental) Should provenance statements be generated when package is published.
default String	getNpmTokenSecret()	(experimental) GitHub secret which contains the NPM token to use when publishing packages.
default String	getRegistry()	(experimental) The domain name of the npm package registry.

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

getCodeArtifactOptions

@Stability(Experimental)
@Nullable
default CodeArtifactOptions getCodeArtifactOptions()

(experimental) Options for publishing npm package to AWS CodeArtifact.

Default: - undefined

getDistTag

@Stability(Deprecated)
@Deprecated
@Nullable
default String getDistTag()

Deprecated.

Use npmDistTag for each release branch instead.

(deprecated) 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.

Default: "latest"

getNpmProvenance

@Stability(Experimental)
@Nullable
default Boolean getNpmProvenance()

(experimental) Should provenance statements be generated when package is published.

Note that this component is using publib to publish packages, which is using npm internally and supports provenance statements independently of the package manager used.

Default: - undefined

See Also:

https://docs.npmjs.com/generating-provenance-statements

getNpmTokenSecret

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

(experimental) GitHub secret which contains the NPM token to use when publishing packages.

Default: - "NPM_TOKEN" or "GITHUB_TOKEN" if `registry` is set to `npm.pkg.github.com`.

getRegistry

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

(experimental) 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.

Default: "registry.npmjs.org"

Example:

 "npm.pkg.github.com"
 

builder

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

Returns:

a NpmPublishOptions.Builder of NpmPublishOptions