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

Class VersionReport

java.lang.Object

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

public final class VersionReport
extends Object

Shared per-module version-analysis snapshot behind explainVersion/explainVersions - both tasks' console output and their build/version-report.json file are built from exactly the same VersionReport.Entry, so the two can never drift from each other, and 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) calls the exact same VersionResolver methods tagReleaseCandidate(s) itself calls, so the preview can never drift from what tagging would actually do either.

A plain class with no Gradle dependency, like VersionResolver/CommitAnalyzer/ ReleaseManifest - independently unit-testable against a real throwaway git repo.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	VersionReport.CommitBreakdown	One commit's syntactic parse plus the bump it resolves to - see CommitAnalyzer.
static final class	VersionReport.Entry	One project's full version-analysis breakdown.

Method Summary

Modifier and Type	Method	Description
static VersionReport.Entry	buildEntry(String module, File repoDir, String tagPrefix, String modulePath, List<String> fallbackPrefixes, Map<CommitAnalyzer.Bump,Set<String>> typeRules, List<String> excludedModulePaths, String forceVersion, String branchName)	Builds one project's VersionReport.Entry by calling the exact same VersionResolver methods tagReleaseCandidate(s) itself calls - see that task's doLast for the call sequence this mirrors.
static String	toJsonArray(List<VersionReport.Entry> entries)	JSON array of entries, e.g.
static void	writeJsonArray(List<VersionReport.Entry> entries, File file)	Writes toJsonArray(java.util.List<io.github.duckasteroid.gradle.versioning.releaseflow.VersionReport.Entry>) 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

Method Details

buildEntry

public static VersionReport.Entry buildEntry(String module,
 File repoDir,
 String tagPrefix,
 String modulePath,
 List<String> fallbackPrefixes,
 Map<CommitAnalyzer.Bump,Set<String>> typeRules,
 List<String> excludedModulePaths,
 String forceVersion,
 String branchName)

Builds one project's VersionReport.Entry by calling the exact same VersionResolver methods tagReleaseCandidate(s) itself calls - see that task's doLast for the call sequence this mirrors. Never tags, pushes, or writes anything other than the returned Entry.

Parameters:

excludedModulePaths - see VersionResolver.resolveBuildVersion - pass an empty list for a single-project computation (matching how the singular tagReleaseCandidate/ordinary-build version resolution never apply exclusions either), or the applying project's own exclusions (from releaseFlowTargets) for the multi-module aggregator.

toJsonArray

public static String toJsonArray(List<VersionReport.Entry> entries)

JSON array of entries, e.g. for explainVersions' build/version-report.json - "[]" when empty.

writeJsonArray

public static void writeJsonArray(List<VersionReport.Entry> entries,
 File file)

Writes toJsonArray(java.util.List<io.github.duckasteroid.gradle.versioning.releaseflow.VersionReport.Entry>) to file, creating parent directories as needed.