Package io.github.cdklabs.projen

Class ReleasableCommits

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.ReleasableCommits

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:42.796Z")
@Stability(Experimental)
public class ReleasableCommits
extends software.amazon.jsii.JsiiObject

(experimental) Find commits that should be considered releasable to decide if a release is required.

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ReleasableCommits(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ReleasableCommits(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
static ReleasableCommits	everyCommit()	(experimental) Release every commit.
static ReleasableCommits	everyCommit(String path)	(experimental) Release every commit.
static ReleasableCommits	exec(String cmd)	(experimental) Use an arbitrary shell command to find releasable commits since the latest tag.
static ReleasableCommits	featuresAndFixes()	(experimental) Release only features and fixes.
static ReleasableCommits	featuresAndFixes(String path)	(experimental) Release only features and fixes.
String	getCmd()
static ReleasableCommits	ofType(List<String> types)	(experimental) Limit commits by their conventional commit type.
static ReleasableCommits	ofType(List<String> types, String path)	(experimental) Limit commits by their conventional commit type.
void	setCmd(String value)

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

ReleasableCommits

protected ReleasableCommits(software.amazon.jsii.JsiiObjectRef objRef)

ReleasableCommits

protected ReleasableCommits(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Method Detail

everyCommit

@Stability(Experimental)
@NotNull
public static ReleasableCommits everyCommit(@Nullable
                                            String path)

(experimental) Release every commit.

This will only not release if the most recent commit is tagged with the latest matching tag.

Parameters:

path - Consider only commits that are enough to explain how the files that match the specified paths came to be.

everyCommit

@Stability(Experimental)
@NotNull
public static ReleasableCommits everyCommit()

(experimental) Release every commit.

This will only not release if the most recent commit is tagged with the latest matching tag.

exec

@Stability(Experimental)
@NotNull
public static ReleasableCommits exec(@NotNull
                                     String cmd)

(experimental) Use an arbitrary shell command to find releasable commits since the latest tag.

A new release will be initiated, if the number of returned commits is greater than zero. Must return a newline separate list of commits that should considered releasable. $LATEST_TAG will be replaced with the actual latest tag for the given prefix.*

Example:

 "git log --oneline $LATEST_TAG..HEAD -- ."
 

Parameters:

cmd - This parameter is required.

featuresAndFixes

@Stability(Experimental)
@NotNull
public static ReleasableCommits featuresAndFixes(@Nullable
                                                 String path)

(experimental) Release only features and fixes.

Shorthand for ReleasableCommits.onlyOfType(['feat', 'fix']).

Parameters:

path - Consider only commits that are enough to explain how the files that match the specified paths came to be.

featuresAndFixes

@Stability(Experimental)
@NotNull
public static ReleasableCommits featuresAndFixes()

(experimental) Release only features and fixes.

Shorthand for ReleasableCommits.onlyOfType(['feat', 'fix']).

ofType

@Stability(Experimental)
@NotNull
public static ReleasableCommits ofType(@NotNull
                                       List<String> types,
                                       @Nullable
                                       String path)

(experimental) Limit commits by their conventional commit type.

This will only release commit that match one of the provided types. Commits are required to follow the conventional commit spec and will be ignored otherwise.

Parameters:

types - List of conventional commit types that should be released. This parameter is required.

path - Consider only commits that are enough to explain how the files that match the specified paths came to be.

ofType

@Stability(Experimental)
@NotNull
public static ReleasableCommits ofType(@NotNull
                                       List<String> types)

(experimental) Limit commits by their conventional commit type.

This will only release commit that match one of the provided types. Commits are required to follow the conventional commit spec and will be ignored otherwise.

Parameters:

types - List of conventional commit types that should be released. This parameter is required.

getCmd

@Stability(Experimental)
@NotNull
public String getCmd()

setCmd

@Stability(Experimental)
public void setCmd(@NotNull
                   String value)