Index (conventional-version 2.1.0 API)

A B C D E F G H I J K L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

allCommits() - Method in class io.github.joke.conventionalversion.git.GitRepository: Every commit reachable from HEAD, oldest first, with their paths.
anyReleasable(List) - Method in class io.github.joke.conventionalversion.LinkedVersionReconciler
apply(Settings) - Method in class io.github.joke.conventionalversion.SettingsVersionPlugin
apply(PluginAware) - Method in class io.github.joke.conventionalversion.ConventionalVersionPlugin: The target type is resolved before the target is touched, so an unsupported one fails without the plugin having reached into it first.
apply(Project) - Method in class io.github.joke.conventionalversion.ProjectVersionPlugin
applyBump(Bump, SemanticVersion, VersionPolicy) - Method in class io.github.joke.conventionalversion.calc.VersionCalculator
ApplyProjectPlugin - Record Class in io.github.joke.conventionalversion: How settings mode reaches every project: by applying ProjectVersionPlugin to each of them.
ApplyProjectPlugin() - Constructor for record class io.github.joke.conventionalversion.ApplyProjectPlugin: Creates an instance of a ApplyProjectPlugin record class.
asObject(String, String, Object) - Method in class io.github.joke.conventionalversion.config.JsonObject
assignment(Project) - Method in class io.github.joke.conventionalversion.ProjectVersionPlugin
AssignVersion - Record Class in io.github.joke.conventionalversion: Assigns one project the version of the package that claims it.
AssignVersion(VersionCatalogue) - Constructor for record class io.github.joke.conventionalversion.AssignVersion: Creates an instance of a AssignVersion record class.

B

baseShaOf(ReleasePackage, SemanticVersion) - Method in class io.github.joke.conventionalversion.git.RepositoryStateReader: The commit a package's recorded release was cut at, found by the tag release-please would create.
bool(String) - Method in class io.github.joke.conventionalversion.config.JsonObject
breaking() - Method in record class io.github.joke.conventionalversion.calc.ConventionalCommit: Returns the value of the breaking record component.
bump() - Method in record class io.github.joke.conventionalversion.calc.VersionResult: Returns the value of the bump record component.
Bump - Enum Class in io.github.joke.conventionalversion.calc: How much of the version a set of commits moves.
bumpForType(String, boolean) - Method in class io.github.joke.conventionalversion.calc.BumpReducer
bumpMajor() - Method in record class io.github.joke.conventionalversion.calc.SemanticVersion
bumpMinor() - Method in record class io.github.joke.conventionalversion.calc.SemanticVersion
bumpMinorPreMajor() - Method in record class io.github.joke.conventionalversion.calc.VersionPolicy: Returns the value of the bumpMinorPreMajor record component.
bumpPatch() - Method in record class io.github.joke.conventionalversion.calc.SemanticVersion
bumpPatchForMinorPreMajor() - Method in record class io.github.joke.conventionalversion.calc.VersionPolicy: Returns the value of the bumpPatchForMinorPreMajor record component.
BumpReducer - Class in io.github.joke.conventionalversion.calc: Reduces a range of commits to the single bump it implies.
BumpReducer() - Constructor for class io.github.joke.conventionalversion.calc.BumpReducer

C

calculate(RepositoryState, VersionPolicy) - Method in class io.github.joke.conventionalversion.calc.VersionCalculator
calculate(Project) - Method in class io.github.joke.conventionalversion.CatalogueSource: The project's own directory as the value source's parameter.
calculateAll(List) - Method in class io.github.joke.conventionalversion.VersionValueSource
calculator() - Method in class io.github.joke.conventionalversion.VersionValueSource
catalogue() - Method in record class io.github.joke.conventionalversion.AssignVersion: Returns the value of the catalogue record component.
catalogue() - Method in class io.github.joke.conventionalversion.VersionCatalogueService
catalogue(String, List, List) - Method in class io.github.joke.conventionalversion.VersionValueSource
catalogue(Project) - Method in class io.github.joke.conventionalversion.CatalogueSource
CatalogueSource - Class in io.github.joke.conventionalversion: How either mode reaches the calculated catalogue: the core's only entry point.
CatalogueSource() - Constructor for class io.github.joke.conventionalversion.CatalogueSource
child(String, Map) - Method in class io.github.joke.conventionalversion.config.JsonObject
claiming(String) - Method in record class io.github.joke.conventionalversion.config.ReleaseConfiguration: The package claiming a repository-relative path, deepest declaration first.
claims(String) - Method in record class io.github.joke.conventionalversion.config.ReleasePackage: Whether a repository-relative path belongs to this package.
command(List) - Method in class io.github.joke.conventionalversion.git.GitCommandRunner: The full argument vector, git first.
Commit - Record Class in io.github.joke.conventionalversion.calc: One commit in the analysed range, with the paths it touched.
Commit(String, String, List) - Constructor for record class io.github.joke.conventionalversion.calc.Commit: Creates an instance of a Commit record class.
CommitMessageParser - Class in io.github.joke.conventionalversion.calc: Extracts the version-relevant facts from a raw commit message.
CommitMessageParser() - Constructor for class io.github.joke.conventionalversion.calc.CommitMessageParser
commitMessages() - Method in record class io.github.joke.conventionalversion.calc.RepositoryState: Returns the value of the commitMessages record component.
compareTo(SemanticVersion) - Method in record class io.github.joke.conventionalversion.calc.SemanticVersion
component() - Method in record class io.github.joke.conventionalversion.config.ReleasePackage: Returns the value of the component record component.
componentOf(JsonObject) - Method in class io.github.joke.conventionalversion.config.ConfigurationReader: The component release-please derives, which under release-type: simple is whatever is declared and otherwise nothing at all — its default package name is empty, and a package's path is never used as a component.
components() - Method in record class io.github.joke.conventionalversion.config.LinkedGroup: Returns the value of the components record component.
CONFIG_FILE - Static variable in class io.github.joke.conventionalversion.config.ConfigurationReader
configurationReader() - Method in class io.github.joke.conventionalversion.VersionValueSource
ConfigurationReader - Class in io.github.joke.conventionalversion.config: Interprets release-please-config.json.
ConfigurationReader() - Constructor for class io.github.joke.conventionalversion.config.ConfigurationReader
contentOf(Path) - Method in class io.github.joke.conventionalversion.VersionValueSource
ConventionalCommit - Record Class in io.github.joke.conventionalversion.calc: A single commit reduced to the facts that affect the version.
ConventionalCommit(String, String, boolean, SemanticVersion) - Constructor for record class io.github.joke.conventionalversion.calc.ConventionalCommit: Creates an instance of a ConventionalCommit record class.
ConventionalVersionException - Exception Class in io.github.joke.conventionalversion.git: A precondition the calculation cannot proceed without.
ConventionalVersionException(String) - Constructor for exception class io.github.joke.conventionalversion.git.ConventionalVersionException
ConventionalVersionException(String, Throwable) - Constructor for exception class io.github.joke.conventionalversion.git.ConventionalVersionException
ConventionalVersionPlugin - Class in io.github.joke.conventionalversion: Assigns projects the version of the release-please package that claims them.
ConventionalVersionPlugin() - Constructor for class io.github.joke.conventionalversion.ConventionalVersionPlugin

D

declared() - Method in record class io.github.joke.conventionalversion.git.RepositoryStateReader.PackageState: Returns the value of the declared record component.
declared() - Method in record class io.github.joke.conventionalversion.VersionCatalogue.PackageVersion: Returns the value of the declared record component.
defaults() - Static method in record class io.github.joke.conventionalversion.calc.VersionPolicy: release-please's defaults.
defaults() - Static method in record class io.github.joke.conventionalversion.config.TagFormat: release-please's defaults: component included, separated by -, version prefixed by v.
depth() - Method in record class io.github.joke.conventionalversion.config.ReleasePackage: How specific this package's claim is, so the deepest declared package wins a contested path.
describe(Object) - Method in class io.github.joke.conventionalversion.config.JsonObject
downgrade(Bump, Bump, boolean) - Method in class io.github.joke.conventionalversion.calc.VersionCalculator

E

effectiveBump(Bump, SemanticVersion, VersionPolicy) - Method in class io.github.joke.conventionalversion.calc.VersionCalculator
elements(String) - Method in class io.github.joke.conventionalversion.config.JsonObject
equals(Object) - Method in record class io.github.joke.conventionalversion.ApplyProjectPlugin: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.joke.conventionalversion.AssignVersion: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.joke.conventionalversion.calc.Commit: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.joke.conventionalversion.calc.ConventionalCommit: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.joke.conventionalversion.calc.RepositoryState: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.joke.conventionalversion.calc.SemanticVersion: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.joke.conventionalversion.calc.VersionPolicy: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.joke.conventionalversion.calc.VersionResult: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.joke.conventionalversion.config.LinkedGroup: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.joke.conventionalversion.config.ReleaseConfiguration: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.joke.conventionalversion.config.ReleasePackage: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.joke.conventionalversion.config.TagFormat: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.joke.conventionalversion.git.RepositoryStateReader.PackageState: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.joke.conventionalversion.VersionCatalogue: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.joke.conventionalversion.VersionCatalogue.PackageVersion: Indicates whether some other object is "equal to" this one.
excludePaths() - Method in record class io.github.joke.conventionalversion.config.ReleasePackage: Returns the value of the excludePaths record component.
execute(Project) - Method in record class io.github.joke.conventionalversion.ApplyProjectPlugin
execute(Project) - Method in record class io.github.joke.conventionalversion.AssignVersion

F

findOverride(List) - Method in class io.github.joke.conventionalversion.calc.VersionCalculator: The most recent override wins, which with an oldest-first range is the last one.
findRecordedRelease() - Method in record class io.github.joke.conventionalversion.calc.RepositoryState
findReleaseAs() - Method in record class io.github.joke.conventionalversion.calc.ConventionalCommit
findReleaseAs(String) - Method in class io.github.joke.conventionalversion.calc.CommitMessageParser: The last footer in the message wins, matching release-please's handling of repeated overrides.
findReleasedVersion(RepositoryState) - Method in class io.github.joke.conventionalversion.calc.VersionCalculator: On a release commit the recorded version is the truth and nothing is derived - not the bump, and not a Release-As: override earlier in history.
findTaggedCommit(String) - Method in class io.github.joke.conventionalversion.git.GitRepository: The commit a tag points at, or empty when no such tag exists.
findType() - Method in record class io.github.joke.conventionalversion.calc.ConventionalCommit
forProject(Path) - Method in record class io.github.joke.conventionalversion.VersionCatalogue: The version for a project directory, by the package whose claim is deepest.

G

getBumpType() - Method in interface io.github.joke.conventionalversion.VersionInfo: What the analysed commits implied, before any override or floor was applied.
getCatalogue() - Method in interface io.github.joke.conventionalversion.VersionCatalogueService.Parameters: Set from the value source's provider, so resolving it is what runs the calculation.
getProjectDirectory() - Method in interface io.github.joke.conventionalversion.VersionValueSource.Parameters
getReleasable() - Method in interface io.github.joke.conventionalversion.VersionInfo: Whether the range warrants a release.
getSha() - Method in interface io.github.joke.conventionalversion.VersionInfo: The commit the build was produced from.
getVersion() - Method in interface io.github.joke.conventionalversion.VersionInfo: The same string assigned as project.version.
GitCommandRunner - Class in io.github.joke.conventionalversion.git: Runs git in a directory and returns its standard output.
GitCommandRunner(File) - Constructor for class io.github.joke.conventionalversion.git.GitCommandRunner
GitRepository - Class in io.github.joke.conventionalversion.git: The repository reads the calculation needs, each one git command.
GitRepository(GitCommandRunner) - Constructor for class io.github.joke.conventionalversion.git.GitRepository
groupOf(VersionCatalogue.PackageVersion, List) - Method in class io.github.joke.conventionalversion.LinkedVersionReconciler
groupOf(String) - Method in record class io.github.joke.conventionalversion.config.ReleaseConfiguration: The group holding a component, when one does.

H

has(String) - Method in class io.github.joke.conventionalversion.config.JsonObject
hashCode() - Method in record class io.github.joke.conventionalversion.ApplyProjectPlugin: Returns a hash code value for this object.
hashCode() - Method in record class io.github.joke.conventionalversion.AssignVersion: Returns a hash code value for this object.
hashCode() - Method in record class io.github.joke.conventionalversion.calc.Commit: Returns a hash code value for this object.
hashCode() - Method in record class io.github.joke.conventionalversion.calc.ConventionalCommit: Returns a hash code value for this object.
hashCode() - Method in record class io.github.joke.conventionalversion.calc.RepositoryState: Returns a hash code value for this object.
hashCode() - Method in record class io.github.joke.conventionalversion.calc.SemanticVersion: Returns a hash code value for this object.
hashCode() - Method in record class io.github.joke.conventionalversion.calc.VersionPolicy: Returns a hash code value for this object.
hashCode() - Method in record class io.github.joke.conventionalversion.calc.VersionResult: Returns a hash code value for this object.
hashCode() - Method in record class io.github.joke.conventionalversion.config.LinkedGroup: Returns a hash code value for this object.
hashCode() - Method in record class io.github.joke.conventionalversion.config.ReleaseConfiguration: Returns a hash code value for this object.
hashCode() - Method in record class io.github.joke.conventionalversion.config.ReleasePackage: Returns a hash code value for this object.
hashCode() - Method in record class io.github.joke.conventionalversion.config.TagFormat: Returns a hash code value for this object.
hashCode() - Method in record class io.github.joke.conventionalversion.git.RepositoryStateReader.PackageState: Returns a hash code value for this object.
hashCode() - Method in record class io.github.joke.conventionalversion.VersionCatalogue: Returns a hash code value for this object.
hashCode() - Method in record class io.github.joke.conventionalversion.VersionCatalogue.PackageVersion: Returns a hash code value for this object.
headerOf(String) - Method in class io.github.joke.conventionalversion.calc.CommitMessageParser
headIsReleaseCommit() - Method in record class io.github.joke.conventionalversion.calc.RepositoryState: Returns the value of the headIsReleaseCommit record component.
headSha() - Method in record class io.github.joke.conventionalversion.calc.RepositoryState: Returns the value of the headSha record component.
headSha() - Method in class io.github.joke.conventionalversion.git.GitRepository
highestOf(List) - Method in class io.github.joke.conventionalversion.LinkedVersionReconciler
holds(String) - Method in record class io.github.joke.conventionalversion.config.LinkedGroup

I

impliedBump(ConventionalCommit) - Method in class io.github.joke.conventionalversion.calc.BumpReducer
includeComponent() - Method in record class io.github.joke.conventionalversion.config.TagFormat: Returns the value of the includeComponent record component.
includeV() - Method in record class io.github.joke.conventionalversion.config.TagFormat: Returns the value of the includeV record component.
inherited(JsonObject, JsonObject, String) - Method in class io.github.joke.conventionalversion.config.ConfigurationReader: A package setting wins over the same setting at the top level, as release-please resolves them.
inheritedText(JsonObject, JsonObject, String) - Method in class io.github.joke.conventionalversion.config.ConfigurationReader
initialVersion() - Method in record class io.github.joke.conventionalversion.calc.VersionPolicy: Returns the value of the initialVersion record component.
io.github.joke.conventionalversion - package io.github.joke.conventionalversion: The Gradle surface: the settings plugin, its configuration, and the value source that reads git.
io.github.joke.conventionalversion.calc - package io.github.joke.conventionalversion.calc: The version calculation core: a pure function from repository facts to a version string.
io.github.joke.conventionalversion.config - package io.github.joke.conventionalversion.config: Reads the configuration release-please keeps in the repository, so that every value which affects a calculated version comes from the release tooling's own declarations rather than from a restatement of them.
io.github.joke.conventionalversion.git - package io.github.joke.conventionalversion.git: Gathers repository facts by running git.
isBreaking(String, String) - Method in class io.github.joke.conventionalversion.calc.CommitMessageParser: Whether the commit declares a breaking change, by either spelling the specification allows.
isInsideWorkTree() - Method in class io.github.joke.conventionalversion.git.GitRepository
isLinkedVersions(JsonObject) - Method in class io.github.joke.conventionalversion.config.ConfigurationReader
isPreMajor() - Method in record class io.github.joke.conventionalversion.calc.SemanticVersion: Whether this version is below 1.0.0, which is the condition both pre-major policies are gated on.
isReleasable() - Method in enum class io.github.joke.conventionalversion.calc.Bump: Whether commits implying this bump warrant a release at all.
isShallow() - Method in class io.github.joke.conventionalversion.git.GitRepository

J

JsonObject - Class in io.github.joke.conventionalversion.config: A parsed JSON object, read by key with the type each caller expects.
JsonObject(Map, String) - Constructor for class io.github.joke.conventionalversion.config.JsonObject
JsonParser - Class in io.github.joke.conventionalversion.config: Parses one of release-please's files into a JsonObject.
JsonParser() - Constructor for class io.github.joke.conventionalversion.config.JsonParser

K

keys() - Method in class io.github.joke.conventionalversion.config.JsonObject: The keys present, in the order the document declared them.

L

LinkedGroup - Record Class in io.github.joke.conventionalversion.config: A set of components release-please releases in lockstep.
LinkedGroup(String, List) - Constructor for record class io.github.joke.conventionalversion.config.LinkedGroup: Creates an instance of a LinkedGroup record class.
linkedGroups() - Method in record class io.github.joke.conventionalversion.config.ReleaseConfiguration: Returns the value of the linkedGroups record component.
LinkedVersionReconciler - Class in io.github.joke.conventionalversion: Raises every member of a linked group to the highest version any member calculated.
LinkedVersionReconciler() - Constructor for class io.github.joke.conventionalversion.LinkedVersionReconciler
logCommits(List) - Method in class io.github.joke.conventionalversion.git.GitRepository

M

major() - Method in record class io.github.joke.conventionalversion.calc.SemanticVersion: Returns the value of the major record component.
MAJOR - Enum constant in enum class io.github.joke.conventionalversion.calc.Bump
MANIFEST_FILE - Static variable in class io.github.joke.conventionalversion.config.ManifestReader
manifestReader() - Method in class io.github.joke.conventionalversion.VersionValueSource
ManifestReader - Class in io.github.joke.conventionalversion.config: Interprets .release-please-manifest.json, the record of what has actually been released.
ManifestReader() - Constructor for class io.github.joke.conventionalversion.config.ManifestReader
membersOf(LinkedGroup, List) - Method in class io.github.joke.conventionalversion.LinkedVersionReconciler
message() - Method in record class io.github.joke.conventionalversion.calc.Commit: Returns the value of the message record component.
messageParser() - Method in class io.github.joke.conventionalversion.VersionValueSource
messagesOf(ReleasePackage, List) - Method in class io.github.joke.conventionalversion.git.RepositoryStateReader: Only the commits that touched a path this package claims contribute to its bump.
minor() - Method in record class io.github.joke.conventionalversion.calc.SemanticVersion: Returns the value of the minor record component.
MINOR - Enum constant in enum class io.github.joke.conventionalversion.calc.Bump

N

name() - Method in record class io.github.joke.conventionalversion.config.LinkedGroup: Returns the value of the name record component.
newSlurper() - Method in class io.github.joke.conventionalversion.config.JsonParser
nextVersion(SemanticVersion, VersionPolicy, Optional, Bump) - Method in class io.github.joke.conventionalversion.calc.VersionCalculator
nonConforming() - Static method in record class io.github.joke.conventionalversion.calc.ConventionalCommit: A message that conforms to nothing and names no version.
NONE - Enum constant in enum class io.github.joke.conventionalversion.calc.Bump

O

object(String) - Method in class io.github.joke.conventionalversion.config.JsonObject
objects(String, String) - Method in class io.github.joke.conventionalversion.config.JsonObject: The elements of an array whose entries are either objects or bare names, with a bare name becoming an object carrying only nameKey.
obtain() - Method in class io.github.joke.conventionalversion.VersionValueSource

P

packages() - Method in record class io.github.joke.conventionalversion.config.ReleaseConfiguration: Returns the value of the packages record component.
packages() - Method in record class io.github.joke.conventionalversion.VersionCatalogue: Returns the value of the packages record component.
PackageState(ReleasePackage, RepositoryState) - Constructor for record class io.github.joke.conventionalversion.git.RepositoryStateReader.PackageState: Creates an instance of a PackageState record class.
PackageVersion(ReleasePackage, VersionResult) - Constructor for record class io.github.joke.conventionalversion.VersionCatalogue.PackageVersion: Creates an instance of a PackageVersion record class.
parse(String) - Method in class io.github.joke.conventionalversion.calc.CommitMessageParser
parse(String) - Static method in record class io.github.joke.conventionalversion.calc.SemanticVersion: Parses 1.2.3, returning empty when the text is not exactly three numeric parts.
parse(String, String) - Method in class io.github.joke.conventionalversion.config.JsonParser: source names the file, so a failure says which one could not be read.
parseAll(List) - Method in class io.github.joke.conventionalversion.calc.VersionCalculator
parseCommit(String) - Method in class io.github.joke.conventionalversion.git.GitRepository
parseCommits(String) - Method in class io.github.joke.conventionalversion.git.GitRepository
parseInitialVersion(String) - Method in class io.github.joke.conventionalversion.config.ConfigurationReader
parsePaths(String) - Method in class io.github.joke.conventionalversion.git.GitRepository
parser() - Method in class io.github.joke.conventionalversion.VersionValueSource
patch() - Method in record class io.github.joke.conventionalversion.calc.SemanticVersion: Returns the value of the patch record component.
PATCH - Enum constant in enum class io.github.joke.conventionalversion.calc.Bump
path() - Method in record class io.github.joke.conventionalversion.config.ReleasePackage: Returns the value of the path record component.
path(String) - Method in class io.github.joke.conventionalversion.config.JsonObject
paths() - Method in record class io.github.joke.conventionalversion.calc.Commit: Returns the value of the paths record component.
pluginFor(PluginAware) - Method in class io.github.joke.conventionalversion.ConventionalVersionPlugin: Gradle is a PluginAware too, so an init script reaches here.
policy() - Method in record class io.github.joke.conventionalversion.config.ReleasePackage: Returns the value of the policy record component.
policyOf(JsonObject, JsonObject) - Method in class io.github.joke.conventionalversion.config.ConfigurationReader
preMajorBump(Bump, VersionPolicy) - Method in class io.github.joke.conventionalversion.calc.VersionCalculator
present(List) - Method in class io.github.joke.conventionalversion.config.JsonObject: A null element is dropped, for the same reason a null value is.
ProjectVersionPlugin - Class in io.github.joke.conventionalversion: Project mode, and the whole of both modes: settings mode is this plugin applied to every project.
ProjectVersionPlugin() - Constructor for class io.github.joke.conventionalversion.ProjectVersionPlugin

R

raise(VersionCatalogue.PackageVersion, List) - Method in class io.github.joke.conventionalversion.LinkedVersionReconciler
raised(VersionResult, SemanticVersion, boolean) - Method in class io.github.joke.conventionalversion.LinkedVersionReconciler: A member already on its release commit stays bare, because the group releasing together does not make an unreleased member released.
raiseIfGrouped(VersionCatalogue.PackageVersion, List, List) - Method in class io.github.joke.conventionalversion.LinkedVersionReconciler
read(JsonObject) - Method in class io.github.joke.conventionalversion.config.ConfigurationReader
read(JsonObject) - Method in class io.github.joke.conventionalversion.config.ManifestReader: Released versions by package path.
read(ReleaseConfiguration, Map) - Method in class io.github.joke.conventionalversion.git.RepositoryStateReader: The state of every declared package, paired with the package itself.
readConfiguration(String) - Method in class io.github.joke.conventionalversion.VersionValueSource
reader(File) - Method in class io.github.joke.conventionalversion.VersionValueSource
readFile(String, String) - Method in class io.github.joke.conventionalversion.VersionValueSource: Manifest mode is required, so an absent file is a failure naming both rather than a fallback.
readGroup(JsonObject) - Method in class io.github.joke.conventionalversion.config.ConfigurationReader
readGroups(JsonObject) - Method in class io.github.joke.conventionalversion.config.ConfigurationReader
readManifest(String) - Method in class io.github.joke.conventionalversion.VersionValueSource
readPackage(String, JsonObject, JsonObject) - Method in class io.github.joke.conventionalversion.config.ConfigurationReader
readPackages(JsonObject) - Method in class io.github.joke.conventionalversion.config.ConfigurationReader
reconcile(List, List) - Method in class io.github.joke.conventionalversion.LinkedVersionReconciler: Every package, with the members of each linked group levelled up to their highest version.
reconciler() - Method in class io.github.joke.conventionalversion.VersionValueSource
recordedRelease() - Method in record class io.github.joke.conventionalversion.calc.RepositoryState: Returns the value of the recordedRelease record component.
reduce(List) - Method in class io.github.joke.conventionalversion.calc.BumpReducer
reducer() - Method in class io.github.joke.conventionalversion.VersionValueSource
refuseSharedTag(Map.Entry) - Method in class io.github.joke.conventionalversion.config.ConfigurationReader
refuseVersionAffecting(JsonObject) - Method in class io.github.joke.conventionalversion.config.ConfigurationReader
releasable() - Method in record class io.github.joke.conventionalversion.calc.VersionResult: Returns the value of the releasable record component.
releaseAs() - Method in record class io.github.joke.conventionalversion.calc.ConventionalCommit: Returns the value of the releaseAs record component.
ReleaseConfiguration - Record Class in io.github.joke.conventionalversion.config: The release layout of a repository: what is releasable, and what is held in lockstep.
ReleaseConfiguration(List, List) - Constructor for record class io.github.joke.conventionalversion.config.ReleaseConfiguration: Creates an instance of a ReleaseConfiguration record class.
releasedResult(SemanticVersion, String) - Method in class io.github.joke.conventionalversion.calc.VersionCalculator
ReleasePackage - Record Class in io.github.joke.conventionalversion.config: One releasable unit, as release-please declares it.
ReleasePackage(String, String, List, TagFormat, VersionPolicy) - Constructor for record class io.github.joke.conventionalversion.config.ReleasePackage: Creates an instance of a ReleasePackage record class.
repository(File) - Method in class io.github.joke.conventionalversion.VersionValueSource
repositoryRoot() - Method in class io.github.joke.conventionalversion.git.GitRepository: The root of the working tree, which is where release-please keeps its configuration.
repositoryRoot() - Method in class io.github.joke.conventionalversion.git.RepositoryStateReader: Where release-please keeps its configuration, which need not be the Gradle build's root.
repositoryRoot() - Method in record class io.github.joke.conventionalversion.VersionCatalogue: Returns the value of the repositoryRoot record component.
RepositoryState - Record Class in io.github.joke.conventionalversion.calc: The repository facts the calculation needs, already gathered.
RepositoryState(SemanticVersion, boolean, List, String) - Constructor for record class io.github.joke.conventionalversion.calc.RepositoryState: Creates an instance of a RepositoryState record class.
RepositoryStateReader - Class in io.github.joke.conventionalversion.git: Gathers what the calculation needs, once per build, for every package at once.
RepositoryStateReader(GitRepository) - Constructor for class io.github.joke.conventionalversion.git.RepositoryStateReader
RepositoryStateReader.PackageState - Record Class in io.github.joke.conventionalversion.git: One package and the repository facts its own range yielded.
requireDistinctTags(List) - Method in class io.github.joke.conventionalversion.config.ConfigurationReader
requireObject(String) - Method in class io.github.joke.conventionalversion.config.JsonObject: The object at a key that must be present, for a caller with nothing sensible to do without it.
requireType(String, Object, Class, String) - Method in class io.github.joke.conventionalversion.config.JsonObject
result() - Method in record class io.github.joke.conventionalversion.VersionCatalogue.PackageVersion: Returns the value of the result record component.
root(Object, String) - Method in class io.github.joke.conventionalversion.config.JsonParser
run(List) - Method in class io.github.joke.conventionalversion.git.GitCommandRunner: Runs a command, failing when git exits non-zero.
runner(File) - Method in class io.github.joke.conventionalversion.VersionValueSource

S

scope() - Method in record class io.github.joke.conventionalversion.calc.ConventionalCommit: Returns the value of the scope record component.
SemanticVersion - Record Class in io.github.joke.conventionalversion.calc: A major.minor.patch version, without pre-release or build metadata.
SemanticVersion(int, int, int) - Constructor for record class io.github.joke.conventionalversion.calc.SemanticVersion: Creates an instance of a SemanticVersion record class.
separator() - Method in record class io.github.joke.conventionalversion.config.TagFormat: Returns the value of the separator record component.
service(Project) - Method in class io.github.joke.conventionalversion.CatalogueSource
SERVICE_NAME - Static variable in class io.github.joke.conventionalversion.CatalogueSource: Named rather than derived, because the name is the identity registerIfAbsent matches on and every project has to land on the same one.
SettingsVersionPlugin - Class in io.github.joke.conventionalversion: Settings mode: every project in the build is versioned, whether or not it takes part.
SettingsVersionPlugin() - Constructor for class io.github.joke.conventionalversion.SettingsVersionPlugin
sha() - Method in record class io.github.joke.conventionalversion.calc.Commit: Returns the value of the sha record component.
sha() - Method in record class io.github.joke.conventionalversion.calc.VersionResult: Returns the value of the sha record component.
since(String, List) - Method in class io.github.joke.conventionalversion.git.RepositoryStateReader: The history after a package's base commit.
slurp(String, String) - Method in class io.github.joke.conventionalversion.config.JsonParser
snapshotResult(RepositoryState, VersionPolicy) - Method in class io.github.joke.conventionalversion.calc.VersionCalculator
source() - Method in class io.github.joke.conventionalversion.ProjectVersionPlugin
start(List) - Method in class io.github.joke.conventionalversion.git.GitCommandRunner: Spawns the command in the working directory.
state() - Method in record class io.github.joke.conventionalversion.git.RepositoryStateReader.PackageState: Returns the value of the state record component.
stateOf(ReleasePackage, SemanticVersion, List, String) - Method in class io.github.joke.conventionalversion.git.RepositoryStateReader
string(String) - Method in class io.github.joke.conventionalversion.config.JsonObject
strings(String) - Method in class io.github.joke.conventionalversion.config.JsonObject: The elements of a string array, or empty when the key is absent.

T

tag(SemanticVersion) - Method in record class io.github.joke.conventionalversion.config.ReleasePackage
tag(String, String) - Method in record class io.github.joke.conventionalversion.config.TagFormat
tagFormat() - Method in record class io.github.joke.conventionalversion.config.ReleasePackage: Returns the value of the tagFormat record component.
TagFormat - Record Class in io.github.joke.conventionalversion.config: How release-please renders a release tag.
TagFormat(boolean, String, boolean) - Constructor for record class io.github.joke.conventionalversion.config.TagFormat: Creates an instance of a TagFormat record class.
tagFormatOf(JsonObject, JsonObject) - Method in class io.github.joke.conventionalversion.config.ConfigurationReader
tagPattern() - Method in record class io.github.joke.conventionalversion.config.ReleasePackage: The tag this package renders for any version.
toString() - Method in record class io.github.joke.conventionalversion.ApplyProjectPlugin: Returns a string representation of this record class.
toString() - Method in record class io.github.joke.conventionalversion.AssignVersion: Returns a string representation of this record class.
toString() - Method in record class io.github.joke.conventionalversion.calc.Commit: Returns a string representation of this record class.
toString() - Method in record class io.github.joke.conventionalversion.calc.ConventionalCommit: Returns a string representation of this record class.
toString() - Method in record class io.github.joke.conventionalversion.calc.RepositoryState: Returns a string representation of this record class.
toString() - Method in record class io.github.joke.conventionalversion.calc.SemanticVersion: Returns a string representation of this record class.
toString() - Method in record class io.github.joke.conventionalversion.calc.VersionPolicy: Returns a string representation of this record class.
toString() - Method in record class io.github.joke.conventionalversion.calc.VersionResult: Returns a string representation of this record class.
toString() - Method in record class io.github.joke.conventionalversion.config.LinkedGroup: Returns a string representation of this record class.
toString() - Method in record class io.github.joke.conventionalversion.config.ReleaseConfiguration: Returns a string representation of this record class.
toString() - Method in record class io.github.joke.conventionalversion.config.ReleasePackage: Returns a string representation of this record class.
toString() - Method in record class io.github.joke.conventionalversion.config.TagFormat: Returns a string representation of this record class.
toString() - Method in record class io.github.joke.conventionalversion.git.RepositoryStateReader.PackageState: Returns a string representation of this record class.
toString() - Method in record class io.github.joke.conventionalversion.VersionCatalogue.PackageVersion: Returns a string representation of this record class.
toString() - Method in record class io.github.joke.conventionalversion.VersionCatalogue: Returns a string representation of this record class.
touches(ReleasePackage, Commit) - Method in class io.github.joke.conventionalversion.git.RepositoryStateReader
tryRun(List) - Method in class io.github.joke.conventionalversion.git.GitCommandRunner: Runs a command, yielding empty when git exits non-zero rather than failing.
type() - Method in record class io.github.joke.conventionalversion.calc.ConventionalCommit: Returns the value of the type record component.
typed(String, Class, String) - Method in class io.github.joke.conventionalversion.config.JsonObject

U

unmatched() - Method in record class io.github.joke.conventionalversion.VersionCatalogue: Returns the value of the unmatched record component.
unmatched(List) - Method in class io.github.joke.conventionalversion.VersionValueSource: Every state carries the same head sha, so any of them names the commit this build came from.
unreleasable(String) - Static method in record class io.github.joke.conventionalversion.VersionCatalogue
UNRELEASED_VERSION - Static variable in record class io.github.joke.conventionalversion.VersionCatalogue: The version of a project that no package claims.

V

valueOf(String) - Static method in enum class io.github.joke.conventionalversion.calc.Bump: Returns the enum constant of this class with the specified name.
values() - Static method in enum class io.github.joke.conventionalversion.calc.Bump: Returns an array containing the constants of this enum class, in the order they are declared.
verifyUsable() - Method in class io.github.joke.conventionalversion.git.GitRepository
version() - Method in record class io.github.joke.conventionalversion.calc.VersionResult: Returns the value of the version record component.
versionAt(JsonObject, String) - Method in class io.github.joke.conventionalversion.config.ManifestReader
VersionCalculator - Class in io.github.joke.conventionalversion.calc: Turns gathered repository facts into a version, predicting what release-please will publish.
VersionCalculator(CommitMessageParser, BumpReducer) - Constructor for class io.github.joke.conventionalversion.calc.VersionCalculator
VersionCatalogue - Record Class in io.github.joke.conventionalversion: Every package's version, and the answer for anything no package claims.
VersionCatalogue(String, List, VersionResult) - Constructor for record class io.github.joke.conventionalversion.VersionCatalogue: Creates an instance of a VersionCatalogue record class.
VersionCatalogue.PackageVersion - Record Class in io.github.joke.conventionalversion: One package and what it resolved to.
VersionCatalogueService - Class in io.github.joke.conventionalversion: The one calculated catalogue, shared by every project in the build.
VersionCatalogueService() - Constructor for class io.github.joke.conventionalversion.VersionCatalogueService
VersionCatalogueService.Parameters - Interface in io.github.joke.conventionalversion
VersionInfo - Interface in io.github.joke.conventionalversion: What the calculation concluded, readable from any project's build logic.
versionOf(VersionResult) - Method in class io.github.joke.conventionalversion.LinkedVersionReconciler: Total: a version that does not parse simply does not take part, rather than failing the build.
VersionPolicy - Record Class in io.github.joke.conventionalversion.calc: The inputs that change the calculated number, named after their release-please counterparts so a divergence between the two configurations is greppable.
VersionPolicy(SemanticVersion, boolean, boolean) - Constructor for record class io.github.joke.conventionalversion.calc.VersionPolicy: Creates an instance of a VersionPolicy record class.
VersionResult - Record Class in io.github.joke.conventionalversion.calc: The outcome of a calculation.
VersionResult(String, Bump, boolean, String) - Constructor for record class io.github.joke.conventionalversion.calc.VersionResult: Creates an instance of a VersionResult record class.
VersionValueSource - Class in io.github.joke.conventionalversion: Reads git and release-please's configuration, then calculates every package's version.
VersionValueSource() - Constructor for class io.github.joke.conventionalversion.VersionValueSource
VersionValueSource.Parameters - Interface in io.github.joke.conventionalversion

W

withRange(String) - Method in class io.github.joke.conventionalversion.git.GitRepository

A B C D E F G H I J K L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form