Package io.github.cdklabs.projen.release

Class JsiiReleaseNpm.Jsii$Proxy

    • Constructor Detail

      • Jsii$Proxy

        protected Jsii$Proxy​(software.amazon.jsii.JsiiObjectRef objRef)
        Deprecated.
        Constructor that initializes the object based on values retrieved from the JsiiObject.
        Parameters:
        objRef - Reference to the JSII managed object.

    • Method Detail

      • getDistTag

        public final String getDistTag()
        Deprecated.
        Description copied from interface: NpmPublishOptions
        (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"

        Specified by:
        getDistTag in interface NpmPublishOptions

      • getNpmTokenSecret

        public final String getNpmTokenSecret()
        Deprecated.
        Description copied from interface: NpmPublishOptions
        (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`.

        Specified by:
        getNpmTokenSecret in interface NpmPublishOptions

      • getRegistry

        public final String getRegistry()
        Deprecated.
        Description copied from interface: NpmPublishOptions
        (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"
        Specified by:
        getRegistry in interface NpmPublishOptions

      • getPostPublishSteps

        public final List<JobStep> getPostPublishSteps()
        Deprecated.
        Description copied from interface: CommonPublishOptions
        (experimental) Steps to execute after executing the publishing command.

        These can be used to add/update the release artifacts ot any other tasks needed.

        Note that when using this in publishToGitHubReleases this will override steps added via addGitHubPostPublishingSteps.

        Specified by:
        getPostPublishSteps in interface CommonPublishOptions

      • getPrePublishSteps

        public final List<JobStep> getPrePublishSteps()
        Deprecated.
        Description copied from interface: CommonPublishOptions
        (experimental) Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.

        These steps are executed after dist/ has been populated with the build output.

        Note that when using this in publishToGitHubReleases this will override steps added via addGitHubPrePublishingSteps.

        Specified by:
        getPrePublishSteps in interface CommonPublishOptions

      • getPublishTools

        public final Tools getPublishTools()
        Deprecated.
        Description copied from interface: CommonPublishOptions
        (experimental) Additional tools to install in the publishing job.

        Default: - no additional tools are installed

        Specified by:
        getPublishTools in interface CommonPublishOptions

      • $jsii$toJson

        @Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
        Deprecated.
        Specified by:
        $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

      • equals

        public final boolean equals​(Object o)
        Deprecated.
        Overrides:
        equals in class Object

      • hashCode

        public final int hashCode()
        Deprecated.
        Overrides:
        hashCode in class Object