Package io.github.cdklabs.projen.release

Class NpmPublishOptions.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • distTag

        @Stability(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

      • npmProvenance

        @Stability(Experimental)
public NpmPublishOptions.Builder npmProvenance​(Boolean npmProvenance)
        Sets the value of NpmPublishOptions.getNpmProvenance()
        Parameters:
        npmProvenance - 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.
        Returns:
        this

      • registry

        @Stability(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

      • postPublishSteps

        @Stability(Experimental)
public NpmPublishOptions.Builder postPublishSteps​(List<? extends JobStep> postPublishSteps)
        Sets the value of CommonPublishOptions.getPostPublishSteps()
        Parameters:
        postPublishSteps - 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.

        Returns:
        this

      • prePublishSteps

        @Stability(Experimental)
public NpmPublishOptions.Builder prePublishSteps​(List<? extends JobStep> prePublishSteps)
        Sets the value of CommonPublishOptions.getPrePublishSteps()
        Parameters:
        prePublishSteps - 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.

        Returns:
        this