guardrail-dev / guardrail-dev/guardrail-maven-plugin

Publish spec files versioned by the version contained in the spec file

Open
#39 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Scala
Stars
2
Forks
6
PR merge metrics
No merged PRs in 30d

Description

An idea is to publish the artifact containing the specfile bound by the spec version number.
This would likely have a few other implications, like
- ... verifying that the spec file is equivalent (not syntactically, but semantically) to what would be published and not failing the build if the file already exists
- ... splitting out a `verify-` variant of this that would be run before publishing any other artifacts, to ensure that what is about to be released is compatible with the specfile that was previously published

This is motivated by attempting to increase confidence in older clients. One of the benefits of generating client libraries in a codebase is confidence around whether the client classes are compatible with dependent libraries, since they are all compiled at the same time.

This is lessened when clients (or servers) are needlessly rolled due to the perception of an upgrade, when in reality it's just the same version of the specfile being published again and again with different version numbers.

Decreasing churn and increasing confidence in "I depended on this version of the wire protocol" instead of "I depended on whatever version of the wire protocol server xyz was compiled against" is the intent behind this issue

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.