Implement standardized versioning #44
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Normalize version strings so they are consistently reported as vVERSION, where VERSION is a valid semantic version string. Custom versions that are not valid semvers are returned as is, and empty strings are returned as v0.0.0.
This commit updates tools/image-tag to always report consistent build information, with escape hatches to force the reported version: 1. If RELEASE_TAG is set (which happens via Drone pipelines), then the script emits the value of the RELEASE_TAG environment variable. 2. If a build is being performed against a Git tag, then the script emits the value of that Git tag. 3. Finally, if neither of the above are true, the version from the VERSION file is used, followed by the prerelease being set to `devel` and the short SHA added as build metadata. Provided healthy workflwos where RELEASE_TAG and Git tags are always semantic versions, this guarantees that versions reported by builds are consistent and can be parsed properly.
rfratto
added
the
backport-to-agent:no
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR implements standardized versioning as first proposed in grafana/agent#6100. A new file called
VERSIONat the root of the repository denotes what semantic version (with avprefix) to report builds as.This helps consistently identify running versions of Alloy, even if they come from the main branch.
The
VERSIONfile always reports what version will be released. From the context of the main branch, this is the next major/minor release, and from the context of a release branch, this is the version that the release branch tracks (including the patch version). Due to this, theVERSIONfile is expected to be updated in the main branch following the creation of a release branch, as that indicates a new release is being worked on in main.The
VERSIONfile is ignored in two scenarios with descending precedence:RELEASE_TAGenvironment variable is set (e.g., when Drone is publishing a release from a Git tag event)v(e.g., when locally producing a build against a tag).In all other cases, the
VERSIONfile is used, and the prerelease is set todevelwith the current commit added as a SHA.