Package io.github.cdklabs.projen.release

Class ReleaseTrigger

  • All Implemented Interfaces:
    software.amazon.jsii.JsiiSerializable
    @Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.270Z")
@Stability(Experimental)
public class ReleaseTrigger
extends software.amazon.jsii.JsiiObject
    (experimental) Used to manage release strategies.

    This includes release and release artifact automation

    • Constructor Detail

      • ReleaseTrigger

        protected ReleaseTrigger​(software.amazon.jsii.JsiiObjectRef objRef)

      • ReleaseTrigger

        protected ReleaseTrigger​(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • Method Detail

      • continuous

        @Stability(Experimental)
@NotNull
public static ReleaseTrigger continuous()
        (experimental) Creates a continuous release trigger.

        Automated releases will occur on every commit.

      • manual

        @Stability(Experimental)
@NotNull
public static ReleaseTrigger manual​(@Nullable
                                    ManualReleaseOptions options)
        (experimental) Creates a manual release trigger.

        Use this option if you want totally manual releases.

        This will give you a release task that, in addition to the normal release activities will trigger a publish:git task. This task will handle project-level changelog management, release tagging, and pushing these artifacts to origin.

        The command used for pushing can be customised by specifying gitPushCommand. Set to an empty string to disable pushing entirely.

        Simply run yarn release to trigger a manual release.

        Parameters:
        options - release options.

      • manual

        @Stability(Experimental)
@NotNull
public static ReleaseTrigger manual()
        (experimental) Creates a manual release trigger.

        Use this option if you want totally manual releases.

        This will give you a release task that, in addition to the normal release activities will trigger a publish:git task. This task will handle project-level changelog management, release tagging, and pushing these artifacts to origin.

        The command used for pushing can be customised by specifying gitPushCommand. Set to an empty string to disable pushing entirely.

        Simply run yarn release to trigger a manual release.

      • scheduled

        @Stability(Experimental)
@NotNull
public static ReleaseTrigger scheduled​(@NotNull
                                       ScheduledReleaseOptions options)
        (experimental) Creates a scheduled release trigger.

        Automated releases will occur based on the provided cron schedule.

        Parameters:
        options - release options. This parameter is required.

      • getIsContinuous

        @Stability(Experimental)
@NotNull
public Boolean getIsContinuous()
        (experimental) Whether or not this is a continuous release.

      • getIsManual

        @Stability(Experimental)
@NotNull
public Boolean getIsManual()
        (experimental) Whether or not this is a manual release trigger.

      • getChangelogPath

        @Stability(Experimental)
@Nullable
public String getChangelogPath()
        (experimental) Project-level changelog file path.

      • getGitPushCommand

        @Stability(Experimental)
@Nullable
public String getGitPushCommand()
        (experimental) Override git-push command used when releasing manually.

        Set to an empty string to disable pushing.

      • getSchedule

        @Stability(Experimental)
@Nullable
public String getSchedule()
        (experimental) Cron schedule for releases.

        Only defined if this is a scheduled release.

        Example: 

         '0 17 * * *' - every day at 5 pm