Repository navigation
docs: require build-docker.sh + version tag so service.version isn't "dev" - #3
Draft
sam-spinner wants to merge 1 commit into
Draft
sam-spinner wants to merge 1 commit into
sam-spinner wants to merge 1 commit into
Conversation
…"dev" The published refinery-base image was built via raw ko/go build without the -X main.BuildID ldflag, so every container reports service.version="dev" in Honeycomb's metrics dataset and builds can't be told apart. Document the BuildID ldflag mechanism (cmd/refinery/main.go), the requirement to build via build-docker.sh, and the v3.2.2-notion.N tagging convention so git describe yields a meaningful version. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Refinery stamps its version into the OTLP
service.versionresource attribute at compile time, from amain.BuildIDsymbol set via ldflags (cmd/refinery/main.go); when the ldflag is absent it falls back to"dev". The publishedrefinery-base:3cfa3f81image was built via a rawko/go build(not the repo'sbuild-docker.sh), soBuildIDwas empty and every container reportsservice.version="dev"— visible in Notion's Honeycombmetricsdataset across dev/staging/prod, making refinery builds impossible to tell apart by version.Docs only. Adds a
## Versioningsection toNOTION_FORK.mddocumenting theBuildIDldflag +"dev"fallback, the requirement to publish therefinery-baseimage viabuild-docker.sh(or any build passing-ldflags "-X main.BuildID=<version>"), and the requirement to tag the forkv3.2.2-notion.N(incrementing-notion.Nper build) sogit describe --tags --match='v[0-9]*'yields a meaningful version. Also tweaks the "Building and deploying" steps to point atbuild-docker.shand warn against rawko build. No source or build-script changes.How was this change tested?
Documentation-only change; no behavior to test.
Screenshots