Package io.github.cdklabs.projen

Class Version.Builder

  • All Implemented Interfaces:
    software.amazon.jsii.Builder<Version>
    Enclosing class:
    Version
    @Stability(Experimental)
public static final class Version.Builder
extends Object
implements software.amazon.jsii.Builder<Version>
    (experimental) A fluent builder for Version.

    • Method Detail

      • create

        @Stability(Experimental)
public static Version.Builder create​(Project project)
        Parameters:
        project - This parameter is required.
        Returns:
        a new instance of Version.Builder.

      • artifactsDirectory

        @Stability(Experimental)
public Version.Builder artifactsDirectory​(String artifactsDirectory)
        (experimental) The name of the directory into which changelog.md and version.txt files are emitted.

        Parameters:
        artifactsDirectory - The name of the directory into which changelog.md and version.txt files are emitted. This parameter is required.
        Returns:
        this

      • versionInputFile

        @Stability(Experimental)
public Version.Builder versionInputFile​(String versionInputFile)
        (experimental) A name of a .json file to set the version field in after a bump.

        Example: 

         "package.json"

        Parameters:
        versionInputFile - A name of a .json file to set the version field in after a bump. This parameter is required.
        Returns:
        this

      • releasableCommits

        @Stability(Experimental)
public Version.Builder releasableCommits​(ReleasableCommits releasableCommits)
        (experimental) Find commits that should be considered releasable Used to decide if a release is required.

        Default: ReleasableCommits.everyCommit()

        Parameters:
        releasableCommits - Find commits that should be considered releasable Used to decide if a release is required. This parameter is required.
        Returns:
        this

      • tagPrefix

        @Stability(Experimental)
public Version.Builder tagPrefix​(String tagPrefix)
        (experimental) The tag prefix corresponding to this version.

        Parameters:
        tagPrefix - The tag prefix corresponding to this version. This parameter is required.
        Returns:
        this

      • versionrcOptions

        @Stability(Experimental)
public Version.Builder versionrcOptions​(Map<String,​? extends Object> versionrcOptions)
        (experimental) Custom configuration for versionrc file used by standard-release.

        Parameters:
        versionrcOptions - Custom configuration for versionrc file used by standard-release. This parameter is required.
        Returns:
        this

      • build

        @Stability(Experimental)
public Version build()
        Specified by:
        build in interface software.amazon.jsii.Builder<Version>
        Returns:
        a newly built instance of Version.