Package io.github.cdklabs.projen.release

Interface ReleaseProjectOptions

    • Method Detail

      • getJsiiReleaseVersion

        @Stability(Experimental)
@Nullable
default String getJsiiReleaseVersion()
        (experimental) Version requirement of publib which is used to publish modules to npm.

        Default: "latest"

      • getMajorVersion

        @Stability(Experimental)
@Nullable
default Number getMajorVersion()
        (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.

      • getMinMajorVersion

        @Stability(Experimental)
@Nullable
default Number getMinMajorVersion()
        (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

      • getNpmDistTag

        @Stability(Experimental)
@Nullable
default String getNpmDistTag()
        (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"

      • getPostBuildSteps

        @Stability(Experimental)
@Nullable
default List<JobStep> getPostBuildSteps()
        (experimental) Steps to execute after build as part of the release workflow.

        Default: []

      • getPrerelease

        @Stability(Experimental)
@Nullable
default String getPrerelease()
        (experimental) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").

        Default: - normal semantic versions

      • getPublishDryRun

        @Stability(Experimental)
@Nullable
default Boolean getPublishDryRun()
        (experimental) Instead of actually publishing to package managers, just print the publishing command.

        Default: false

      • getPublishTasks

        @Stability(Experimental)
@Nullable
default Boolean getPublishTasks()
        (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

      • getReleasableCommits

        @Stability(Experimental)
@Nullable
default ReleasableCommits getReleasableCommits()
        (experimental) Find commits that should be considered releasable Used to decide if a release is required.

        Default: ReleasableCommits.everyCommit()

      • getReleaseBranches

        @Stability(Experimental)
@Nullable
default Map<String,​BranchOptions> getReleaseBranches()
        (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.

      • getReleaseEveryCommit

        @Stability(Deprecated)
@Deprecated
@Nullable
default Boolean getReleaseEveryCommit()
        Deprecated.
        Use releaseTrigger: ReleaseTrigger.continuous() instead
        (deprecated) Automatically release new versions every commit to one of branches in releaseBranches.

        Default: true

      • getReleaseFailureIssue

        @Stability(Experimental)
@Nullable
default Boolean getReleaseFailureIssue()
        (experimental) Create a github issue on every failed publishing task.

        Default: false

      • getReleaseFailureIssueLabel

        @Stability(Experimental)
@Nullable
default String getReleaseFailureIssueLabel()
        (experimental) The label to apply to issues indicating publish failures.

        Only applies if releaseFailureIssue is true.

        Default: "failed-release"

      • getReleaseSchedule

        @Stability(Deprecated)
@Deprecated
@Nullable
default String getReleaseSchedule()
        Deprecated.
        Use releaseTrigger: ReleaseTrigger.scheduled() instead
        (deprecated) CRON schedule to trigger new releases.

        Default: - no scheduled releases

      • getReleaseTagPrefix

        @Stability(Experimental)
@Nullable
default String getReleaseTagPrefix()
        (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"

      • getReleaseTrigger

        @Stability(Experimental)
@Nullable
default ReleaseTrigger getReleaseTrigger()
        (experimental) The release trigger to use.

        Default: - Continuous releases (`ReleaseTrigger.continuous()`)

      • getReleaseWorkflowName

        @Stability(Experimental)
@Nullable
default String getReleaseWorkflowName()
        (experimental) The name of the default release workflow.

        Default: "release"

      • getReleaseWorkflowSetupSteps

        @Stability(Experimental)
@Nullable
default List<JobStep> getReleaseWorkflowSetupSteps()
        (experimental) A set of workflow steps to execute in order to setup the workflow container.

      • getVersionrcOptions

        @Stability(Experimental)
@Nullable
default Map<String,​Object> getVersionrcOptions()
        (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

      • getWorkflowContainerImage

        @Stability(Experimental)
@Nullable
default String getWorkflowContainerImage()
        (experimental) Container image to use for GitHub workflows.

        Default: - default image

      • getWorkflowRunsOn

        @Stability(Experimental)
@Nullable
default List<String> getWorkflowRunsOn()
        (experimental) Github Runner selection labels.

        Default: ["ubuntu-latest"]

      • getWorkflowRunsOnGroup

        @Stability(Experimental)
@Nullable
default GroupRunnerOptions getWorkflowRunsOnGroup()
        (experimental) Github Runner Group selection options.