Index (conventional-version 1.0.0 API)

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

A

allCommitMessages() - Method in class io.github.joke.conventionalversion.git.GitRepository: Messages of every commit reachable from HEAD, oldest first.
allCommitMessages() - Method in class io.github.joke.conventionalversion.git.RepositoryStateReader: An empty repository has no HEAD to log, which is still the "never released" case.
apply(Settings) - Method in class io.github.joke.conventionalversion.ConventionalVersionPlugin
applyBump(Bump, SemanticVersion, VersionPolicy) - Method in class io.github.joke.conventionalversion.calc.VersionCalculator
applyDefaults(ConventionalVersionExtension) - Method in class io.github.joke.conventionalversion.ConventionalVersionPlugin
assignVersions(Settings, ConventionalVersionExtension) - Method in class io.github.joke.conventionalversion.ConventionalVersionPlugin: Resolves the version once, then hands the plain result to every project.

B

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(Settings, ConventionalVersionExtension) - Method in class io.github.joke.conventionalversion.ConventionalVersionPlugin
ChangelogReader - Class in io.github.joke.conventionalversion.calc: Reads the last released version out of the changelog release-please maintains.
ChangelogReader() - Constructor for class io.github.joke.conventionalversion.calc.ChangelogReader
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.
commitMessagesSince(String) - Method in class io.github.joke.conventionalversion.git.GitRepository: Messages of the commits reachable from HEAD but not from sinceCommit, oldest first.
compareTo(SemanticVersion) - Method in record class io.github.joke.conventionalversion.calc.SemanticVersion
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
ConventionalVersionExtension - Interface in io.github.joke.conventionalversion: Configuration, in the settings file.
ConventionalVersionPlugin - Class in io.github.joke.conventionalversion: Assigns every project in the build a version calculated from conventional commits.
ConventionalVersionPlugin() - Constructor for class io.github.joke.conventionalversion.ConventionalVersionPlugin

D

defaults() - Static method in record class io.github.joke.conventionalversion.calc.VersionPolicy: release-please's defaults.
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
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.
EXTENSION_NAME - Static variable in class io.github.joke.conventionalversion.ConventionalVersionPlugin

F

findLatestRelease(String) - Method in class io.github.joke.conventionalversion.calc.ChangelogReader: The topmost heading is the most recent release.
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
findRecordedRelease() - Method in class io.github.joke.conventionalversion.git.RepositoryStateReader
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

G

getBumpMinorPreMajor() - Method in interface io.github.joke.conventionalversion.ConventionalVersionExtension: Below 1.0.0, treat a breaking change as a minor bump instead of a major one.
getBumpMinorPreMajor() - Method in interface io.github.joke.conventionalversion.VersionValueSource.Parameters
getBumpPatchForMinorPreMajor() - Method in interface io.github.joke.conventionalversion.ConventionalVersionExtension: Below 1.0.0, treat a feature as a patch bump instead of a minor one.
getBumpPatchForMinorPreMajor() - Method in interface io.github.joke.conventionalversion.VersionValueSource.Parameters
getBumpType() - Method in interface io.github.joke.conventionalversion.VersionInfo: What the analysed commits implied, before any override or floor was applied.
getInitialVersion() - Method in interface io.github.joke.conventionalversion.ConventionalVersionExtension: The version a project that has never released starts at.
getInitialVersion() - Method in interface io.github.joke.conventionalversion.VersionValueSource.Parameters
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.
getTagPrefix() - Method in interface io.github.joke.conventionalversion.ConventionalVersionExtension: Prefix on release tags.
getTagPrefix() - Method in interface io.github.joke.conventionalversion.VersionValueSource.Parameters
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

H

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.
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

I

impliedBump(ConventionalCommit) - Method in class io.github.joke.conventionalversion.calc.BumpReducer
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.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
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

L

logMessages(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
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

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

obtain() - Method in class io.github.joke.conventionalversion.VersionValueSource

P

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.
parseAll(List) - Method in class io.github.joke.conventionalversion.calc.VersionCalculator
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
preMajorBump(Bump, VersionPolicy) - Method in class io.github.joke.conventionalversion.calc.VersionCalculator

R

read(String) - Method in class io.github.joke.conventionalversion.git.RepositoryStateReader
readChangelog() - Method in class io.github.joke.conventionalversion.git.RepositoryStateReader: An absent changelog is the "never released" case, not an error.
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
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.
releasedResult(SemanticVersion, String) - Method in class io.github.joke.conventionalversion.calc.VersionCalculator
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 everything the calculation needs from a checkout.
RepositoryStateReader(GitRepository, ChangelogReader, Path) - Constructor for class io.github.joke.conventionalversion.git.RepositoryStateReader
run(List) - Method in class io.github.joke.conventionalversion.git.GitCommandRunner: Runs a command, failing when git exits non-zero.

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.
sha() - Method in record class io.github.joke.conventionalversion.calc.VersionResult: Returns the value of the sha record component.
snapshotResult(RepositoryState, VersionPolicy) - Method in class io.github.joke.conventionalversion.calc.VersionCalculator
splitRecords(String) - Method in class io.github.joke.conventionalversion.git.GitRepository
start(List) - Method in class io.github.joke.conventionalversion.git.GitCommandRunner
stateAtRelease(SemanticVersion, String, String) - Method in class io.github.joke.conventionalversion.git.RepositoryStateReader
stateWithoutRelease(String) - Method in class io.github.joke.conventionalversion.git.RepositoryStateReader

T

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.
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.

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.
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
VersionInfo - Interface in io.github.joke.conventionalversion: What the calculation concluded, readable from any project's build logic.
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 calculates the version, as a value source.
VersionValueSource() - Constructor for class io.github.joke.conventionalversion.VersionValueSource
VersionValueSource.Parameters - Interface in io.github.joke.conventionalversion: Everything that can change the answer, so that changing any of it re-runs the calculation.

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