Package io.github.cdklabs.projen.release

Class ReleaseProjectOptions.Jsii$Proxy

    • Constructor Detail

      • Jsii$Proxy

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

    • Method Detail

      • getMajorVersion

        public final Number getMajorVersion()
        Description copied from interface: ReleaseProjectOptions
        (experimental) Major version to release from the default branch.

        If this is specified, we bump the latest version of this major version line. If not specified, we bump the global latest version.

        Default: - Major version is not enforced.

        Specified by:
        getMajorVersion in interface ReleaseProjectOptions

      • getMinMajorVersion

        public final Number getMinMajorVersion()
        Description copied from interface: ReleaseProjectOptions
        (experimental) Minimal Major version to release.

        This can be useful to set to 1, as breaking changes before the 1.x major release are not incrementing the major version number.

        Can not be set together with majorVersion.

        Default: - No minimum version is being enforced

        Specified by:
        getMinMajorVersion in interface ReleaseProjectOptions

      • getNpmDistTag

        public final String getNpmDistTag()
        Description copied from interface: ReleaseProjectOptions
        (experimental) The npmDistTag to use when publishing from the default branch.

        To set the npm dist-tag for release branches, set the npmDistTag property for each branch.

        Default: "latest"

        Specified by:
        getNpmDistTag in interface ReleaseProjectOptions

      • getPrerelease

        public final String getPrerelease()
        Description copied from interface: ReleaseProjectOptions
        (experimental) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").

        Default: - normal semantic versions

        Specified by:
        getPrerelease in interface ReleaseProjectOptions

      • getPublishTasks

        public final Boolean getPublishTasks()
        Description copied from interface: ReleaseProjectOptions
        (experimental) Define publishing tasks that can be executed manually as well as workflows.

        Normally, publishing only happens within automated workflows. Enable this in order to create a publishing task for each publishing activity.

        Default: false

        Specified by:
        getPublishTasks in interface ReleaseProjectOptions

      • getReleaseBranches

        public final Map<String,​BranchOptions> getReleaseBranches()
        Description copied from interface: ReleaseProjectOptions
        (experimental) Defines additional release branches.

        A workflow will be created for each release branch which will publish releases from commits in this branch. Each release branch must be assigned a major version number which is used to enforce that versions published from that branch always use that major version. If multiple branches are used, the majorVersion field must also be provided for the default branch.

        Default: - no additional branches are used for release. you can use `addBranch()` to add additional branches.

        Specified by:
        getReleaseBranches in interface ReleaseProjectOptions

      • getReleaseTagPrefix

        public final String getReleaseTagPrefix()
        Description copied from interface: ReleaseProjectOptions
        (experimental) Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.

        Note: this prefix is used to detect the latest tagged version when bumping, so if you change this on a project with an existing version history, you may need to manually tag your latest release with the new prefix.

        Default: "v"

        Specified by:
        getReleaseTagPrefix in interface ReleaseProjectOptions

      • getVersionrcOptions

        public final Map<String,​Object> getVersionrcOptions()
        Description copied from interface: ReleaseProjectOptions
        (experimental) Custom configuration used when creating changelog with standard-version package.

        Given values either append to default configuration or overwrite values in it.

        Default: - standard configuration applicable for GitHub repositories

        Specified by:
        getVersionrcOptions in interface ReleaseProjectOptions

      • $jsii$toJson

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

      • hashCode

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