Class RepositoryStateReader

java.lang.Object

io.github.joke.conventionalversion.git.RepositoryStateReader

public class RepositoryStateReader
extends Object

Gathers everything the calculation needs from a checkout.

The changelog says which version was last released, the tag says where. Tags alone are not enough: release-please's notion of "released" is a GitHub Release it created, so a tag made by hand is invisible to it and reading the highest tag would disagree with release-please exactly when someone has tagged manually.

Constructor Summary

Constructors

Constructor	Description
RepositoryStateReader(GitRepository repository, ChangelogReader changelogReader, Path projectDirectory)

Method Summary

Modifier and Type	Method	Description
protected List<String>	allCommitMessages()	An empty repository has no HEAD to log, which is still the "never released" case.
protected Optional<SemanticVersion>	findRecordedRelease()
RepositoryState	read(String tagPrefix)
protected String	readChangelog()	An absent changelog is the "never released" case, not an error.
protected RepositoryState	stateAtRelease(SemanticVersion recorded, String tagPrefix, String headSha)
protected RepositoryState	stateWithoutRelease(String headSha)

Methods inherited from class Object

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

Constructor Details

RepositoryStateReader

public RepositoryStateReader(GitRepository repository,
 ChangelogReader changelogReader,
 Path projectDirectory)

Method Details

read

public RepositoryState read(String tagPrefix)

findRecordedRelease

@VisibleForTesting
protected Optional<SemanticVersion> findRecordedRelease()

readChangelog

@VisibleForTesting
protected String readChangelog()

An absent changelog is the "never released" case, not an error.

stateAtRelease

@VisibleForTesting
protected RepositoryState stateAtRelease(SemanticVersion recorded,
 String tagPrefix,
 String headSha)

stateWithoutRelease

@VisibleForTesting
protected RepositoryState stateWithoutRelease(String headSha)

allCommitMessages

@VisibleForTesting
protected List<String> allCommitMessages()

An empty repository has no HEAD to log, which is still the "never released" case.