Class ConfigurationReader

java.lang.Object

io.github.joke.conventionalversion.config.ConfigurationReader

public class ConfigurationReader
extends Object

Interprets release-please-config.json.

Every option that changes a number is taken from here rather than restated in the build, so the two cannot disagree. Where release-please does something this project does not model, the build fails naming it: a coordinate that quietly ignores configuration is the failure this plugin exists to prevent, and refusing loudly keeps deferring a feature safe.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_FILE

Constructor Summary

Constructors

Constructor	Description
ConfigurationReader()

Method Summary

Modifier and Type	Method	Description
protected String	componentOf(JsonObject scope)	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.
protected Optional<Boolean>	inherited(JsonObject scope, JsonObject config, String key)	A package setting wins over the same setting at the top level, as release-please resolves them.
protected Optional<String>	inheritedText(JsonObject scope, JsonObject config, String key)
protected boolean	isLinkedVersions(JsonObject plugin)
protected SemanticVersion	parseInitialVersion(String text)
protected VersionPolicy	policyOf(JsonObject scope, JsonObject config)
ReleaseConfiguration	read(JsonObject config)
protected LinkedGroup	readGroup(JsonObject plugin)
protected List<LinkedGroup>	readGroups(JsonObject config)
protected ReleasePackage	readPackage(String path, JsonObject scope, JsonObject config)
protected List<ReleasePackage>	readPackages(JsonObject config)
protected void	refuseSharedTag(Map.Entry<String, List<ReleasePackage>> shared)
protected void	refuseVersionAffecting(JsonObject scope)
protected void	requireDistinctTags(List<ReleasePackage> packages)
protected TagFormat	tagFormatOf(JsonObject scope, JsonObject config)

Methods inherited from class Object

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

Field Details

CONFIG_FILE

public static final String CONFIG_FILE

See Also:

• Constant Field Values

Constructor Details

ConfigurationReader

public ConfigurationReader()

Method Details

read

public ReleaseConfiguration read(JsonObject config)

readPackages

@VisibleForTesting
protected List<ReleasePackage> readPackages(JsonObject config)

readPackage

@VisibleForTesting
protected ReleasePackage readPackage(String path,
 JsonObject scope,
 JsonObject config)

componentOf

@VisibleForTesting
protected String componentOf(JsonObject scope)

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.

tagFormatOf

@VisibleForTesting
protected TagFormat tagFormatOf(JsonObject scope,
 JsonObject config)

policyOf

@VisibleForTesting
protected VersionPolicy policyOf(JsonObject scope,
 JsonObject config)

parseInitialVersion

@VisibleForTesting
protected SemanticVersion parseInitialVersion(String text)

inherited

@VisibleForTesting
protected Optional<Boolean> inherited(JsonObject scope,
 JsonObject config,
 String key)

A package setting wins over the same setting at the top level, as release-please resolves them.

inheritedText

@VisibleForTesting
protected Optional<String> inheritedText(JsonObject scope,
 JsonObject config,
 String key)

refuseVersionAffecting

@VisibleForTesting
protected void refuseVersionAffecting(JsonObject scope)

requireDistinctTags

@VisibleForTesting
protected void requireDistinctTags(List<ReleasePackage> packages)

refuseSharedTag

@VisibleForTesting
protected void refuseSharedTag(Map.Entry<String, List<ReleasePackage>> shared)

readGroups

@VisibleForTesting
protected List<LinkedGroup> readGroups(JsonObject config)

isLinkedVersions

@VisibleForTesting
protected boolean isLinkedVersions(JsonObject plugin)

readGroup

@VisibleForTesting
protected LinkedGroup readGroup(JsonObject plugin)