Package io.github.duckasteroid.gradle.versioning

Enum Class ChangelogScope

java.lang.Object

java.lang.Enum<ChangelogScope>

io.github.duckasteroid.gradle.versioning.ChangelogScope

All Implemented Interfaces:

Serializable, Comparable<ChangelogScope>, Constable

public enum ChangelogScope
extends Enum<ChangelogScope>

How far back the release-flow plugin's changelog generator should look when generating notes for a release candidate (the changelogForReleaseCandidate task, controlled via the changelog { rcScope = ... } extension). Not used by changelogForRelease - promoting an RC to a final release always covers everything since the last final release, since that's the complete picture for the actual release, regardless of how many RCs it took to get there or what rcScope is set to.

Lives in this package (not the release-flow plugin's own) because VersionResolver itself takes a ChangelogScope parameter (VersionResolver.commitMessagesForChangelog(java.io.File, java.lang.String, java.lang.String, java.util.List<java.lang.String>, io.github.duckasteroid.gradle.versioning.ChangelogScope)) - the commit-listing logic is shared, so the enum it's parameterized by has to be visible from here too.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
SINCE_LAST_RELEASE	Every commit since the last final release (default) - the complete picture across every RC in this cycle so far, not just what's new since the previous RC.
SINCE_PREVIOUS_RC	Only commits since the previous release-candidate tag - a delta, useful for reviewers re-checking what changed in a bumped RC rather than re-reading the whole cycle again.

Method Summary

Modifier and Type	Method	Description
static ChangelogScope	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ChangelogScope[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SINCE_LAST_RELEASE

public static final ChangelogScope SINCE_LAST_RELEASE

Every commit since the last final release (default) - the complete picture across every RC in this cycle so far, not just what's new since the previous RC.

SINCE_PREVIOUS_RC

public static final ChangelogScope SINCE_PREVIOUS_RC

Only commits since the previous release-candidate tag - a delta, useful for reviewers re-checking what changed in a bumped RC rather than re-reading the whole cycle again. Falls back to SINCE_LAST_RELEASE automatically when there is no previous RC tag yet (the first RC in a cycle has nothing to diff against).

Method Details

values

public static ChangelogScope[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ChangelogScope valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null