Package io.github.duckasteroid.gradle.versioning.releaseflow

Class VersionReport.Entry

java.lang.Object

io.github.duckasteroid.gradle.versioning.releaseflow.VersionReport.Entry

Enclosing class:

VersionReport

public static final class VersionReport.Entry
extends Object

One project's full version-analysis breakdown. action/reason are left unset (and omitted from the JSON) for a lone VersionReport.buildEntry(java.lang.String, java.io.File, java.lang.String, java.lang.String, java.util.List<java.lang.String>, java.util.Map<io.github.duckasteroid.gradle.versioning.CommitAnalyzer.Bump, java.util.Set<java.lang.String>>, java.util.List<java.lang.String>, java.lang.String, java.lang.String) result - explainVersion has nothing to decide, it just reports. explainVersions sets them after the fact to record its own skip/tag decision for that module, mirroring tagReleaseCandidates' own decision so the two tasks can never disagree about which modules qualify.

Constructor Summary

Constructors

Constructor	Description
Entry(String module, String tagPrefix, String modulePath, String lastFinal, List<VersionReport.CommitBreakdown> commits, String bump, String candidate, String forceVersion, String nextReleaseCandidateTag, String buildVersion)

Method Summary

Modifier and Type	Method	Description
String	getAction()
String	getBuildVersion()
String	getBump()
String	getCandidate()
List<VersionReport.CommitBreakdown>	getCommits()
String	getForceVersion()
String	getLastFinal()
String	getModule()
String	getModulePath()
String	getNextReleaseCandidateTag()
String	getReason()
String	getTagPrefix()
String	render()	Human-readable console breakdown printed by both explainVersion and explainVersions.
void	setAction(String action)
void	setReason(String reason)
String	toJson()	Single-entry JSON, e.g.
Map<String,Object>	toMap()
void	writeTo(File file)	Writes toJson() to file, creating parent directories as needed.

Methods inherited from class java.lang.Object

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

Constructor Details

Entry

public Entry(String module,
 String tagPrefix,
 String modulePath,
 String lastFinal,
 List<VersionReport.CommitBreakdown> commits,
 String bump,
 String candidate,
 String forceVersion,
 String nextReleaseCandidateTag,
 String buildVersion)

Method Details

getModule

public String getModule()

getTagPrefix

public String getTagPrefix()

getModulePath

public String getModulePath()

getLastFinal

public String getLastFinal()

getCommits

public List<VersionReport.CommitBreakdown> getCommits()

getBump

public String getBump()

getCandidate

public String getCandidate()

getForceVersion

public String getForceVersion()

getNextReleaseCandidateTag

public String getNextReleaseCandidateTag()

getBuildVersion

public String getBuildVersion()

getAction

public String getAction()

setAction

public void setAction(String action)

getReason

public String getReason()

setReason

public void setReason(String reason)

toMap

public Map<String,Object> toMap()

toJson

public String toJson()

Single-entry JSON, e.g. for explainVersion's build/version-report.json.

writeTo

public void writeTo(File file)

Writes toJson() to file, creating parent directories as needed.

render

public String render()

Human-readable console breakdown printed by both explainVersion and explainVersions.