Package io.github.cdklabs.projen.release

Interface PublisherOptions

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable
    All Known Implementing Classes:
    PublisherOptions.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.256Z")
@Stability(Experimental)
public interface PublisherOptions
extends software.amazon.jsii.JsiiSerializable
    (experimental) Options for Publisher.

    • Method Detail

      • getArtifactName

        @Stability(Experimental)
@NotNull
String getArtifactName()
        (experimental) The name of the artifact to download (e.g. dist).

        The artifact is expected to include a subdirectory for each release target: go (GitHub), dotnet (NuGet), java (Maven), js (npm), python (PyPI).

        See Also:
        https://github.com/aws/publib

      • getBuildJobId

        @Stability(Experimental)
@NotNull
String getBuildJobId()
        (experimental) The job ID that produces the build artifacts.

        All publish jobs will take a dependency on this job.

      • getCondition

        @Stability(Experimental)
@Nullable
default String getCondition()
        (experimental) A GitHub workflow expression used as a condition for publishers.

        Default: - no condition

      • getDryRun

        @Stability(Experimental)
@Nullable
default Boolean getDryRun()
        (experimental) Do not actually publish, only print the commands that would be executed instead.

        Useful if you wish to block all publishing from a single option.

      • getFailureIssue

        @Stability(Experimental)
@Nullable
default Boolean getFailureIssue()
        (experimental) Create an issue when a publish task fails.

        Default: false

      • getFailureIssueLabel

        @Stability(Experimental)
@Nullable
default String getFailureIssueLabel()
        (experimental) The label to apply to the issue marking failed publish tasks.

        Only applies if failureIssue is true.

        Default: "failed-release"

      • getJsiiReleaseVersion

        @Stability(Deprecated)
@Deprecated
@Nullable
default String getJsiiReleaseVersion()
        Deprecated.
        use publibVersion instead

      • getPublibVersion

        @Stability(Experimental)
@Nullable
default String getPublibVersion()
        (experimental) Version requirement for publib.

        Default: "latest"

      • 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

      • getWorkflowContainerImage

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

        Default: - default image

      • getWorkflowNodeVersion

        @Stability(Experimental)
@Nullable
default String getWorkflowNodeVersion()
        (experimental) Node version to setup in GitHub workflows if any node-based CLI utilities are needed.

        For example publib, the CLI projen uses to publish releases, is an npm library.

        Default: 18.x

      • 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.