feat(push): derive VERSION from CI tag refs and git describe#75
Conversation
|
Caution Review failedThe pull request is closed. 📝 WalkthroughWalkthroughThe PR updates push command version resolution to prefer CI/CD tag refs, adds helpers to parse those refs, falls back to Changes
Sequence DiagramsequenceDiagram
participant CLI as CLI Push
participant Ver as Version Resolver
participant CI as CI/CD Env
participant Git as Git
participant Build as Build System
CLI->>Ver: determineVersion(optional tag)
alt tag provided
Ver-->>CLI: use provided tag
else tag empty
Ver->>CI: read env (GITHUB_REF, GITHUB_REF_TYPE, GITHUB_REF_NAME, CI_COMMIT_TAG, BUILD_SOURCEBRANCH)
CI-->>Ver: ref values
alt tag ref found
Ver->>Ver: parseTagRef(ref)
Ver-->>CLI: extracted version
else no tag ref
Ver->>Git: git describe --dirty
Git-->>Ver: git describe output
Ver-->>CLI: version from git
end
end
CLI->>Build: run build with VERSION env var set
Build-->>CLI: build complete
Estimated Code Review Effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Pull request overview
This PR improves gordon push version resolution by preferring CI-provided tag references (GitHub/GitLab/Azure) before falling back to local git describe, and ensures the resolved VERSION is available to Docker builds.
Changes:
- Add CI tag-ref parsing (
refs/tags/*) and use it as the first source for the version when--tagisn’t provided. - Pass
VERSIONintodocker buildx buildvia environment +--build-arg VERSION(env-resolved). - Update docs and add unit tests for tag-ref parsing and CI env precedence.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| internal/adapters/in/cli/push.go | Adds CI-based version detection, updates git describe behavior, and injects VERSION into Docker build. |
| internal/adapters/in/cli/push_test.go | Adds tests for tag-ref parsing and CI env version resolution; updates build-arg expectations. |
| docs/cli/push.md | Documents the new version resolution order and VERSION injection behavior. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| // using docker push gives us chunked uploads (~5MB per request). | ||
| fmt.Println("\nBuilding image...") | ||
| buildCmd := exec.CommandContext(ctx, "docker", buildImageArgs(version, platform, dockerfile, buildArgs, versionRef, latestRef)...) // #nosec G204 | ||
| buildCmd.Env = append(os.Environ(), "VERSION="+version) |
There was a problem hiding this comment.
buildCmd.Env = append(os.Environ(), "VERSION="+version) can leave duplicate VERSION entries if the parent process already has VERSION set. Many getenv implementations return the first match, so Docker may read the preexisting value instead of the computed one, causing --build-arg VERSION to resolve incorrectly. Prefer constructing Env by replacing any existing VERSION= entry (or prepending the new VERSION=... before os.Environ()) so the intended value always wins.
| buildCmd.Env = append(os.Environ(), "VERSION="+version) | |
| buildCmd.Env = append([]string{"VERSION=" + version}, os.Environ()...) |
| } | ||
|
|
||
| func parseTagRef(ref string) string { | ||
| ref = strings.TrimSpace(strings.TrimSuffix(ref, "^{}")) |
There was a problem hiding this comment.
parseTagRef trims ^{} before trimming whitespace. If a ref ever includes trailing whitespace/newlines (common with env-var values), TrimSuffix(ref, "^{}") won’t match and the returned tag could incorrectly include ^{}. Consider TrimSpace first, then TrimSuffix, or iteratively strip both to make the function correct in isolation.
| ref = strings.TrimSpace(strings.TrimSuffix(ref, "^{}")) | |
| ref = strings.TrimSpace(ref) | |
| ref = strings.TrimSuffix(ref, "^{}") |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@docs/getting-started.md`:
- Around line 121-127: Clarify that using --expiry 0 when running gordon auth
token generate --subject deploy --scopes push,pull --expiry 0 creates a
non‑expiring token and is a security risk; update the docs to add a brief
warning next to the command about long‑lived secrets, recommend scoping the
token (push,pull), suggest setting a finite expiry value instead of 0 and/or
establishing a rotation policy, and mention storing the token securely and
limiting its use to remote deploys.
- Around line 142-147: Update the `--build` explanation for `gordon push myapp`
to state that the `--build` flag runs `docker buildx build` and therefore
requires Docker with Buildx (not a Podman-only setup); edit the sentence around
the `--build` bullet (the line referencing `docker buildx build`) to add a
one-line note that Podman alone is not supported for `--build` or alternatively
mention any supported Podman workaround if available.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@docs/getting-started.md`:
- Around line 148-149: Update the `--build` description to explicitly state how
VERSION is resolved: explain that VERSION is taken from CI tag refs
(refs/tags/*) when present, and otherwise falls back to the output of `git
describe --dirty`; also add or reference the `docs/cli/push.md` link for full
resolution details so users know which tag/source determines VERSION.
| - `--build` runs `docker buildx build` first, injecting `VERSION` from the tag | ||
| into the build and then pushing both version and `latest` tags. This requires |
There was a problem hiding this comment.
🧹 Nitpick | 🔵 Trivial
Clarify how VERSION is determined.
The phrase "injecting VERSION from the tag" is somewhat vague. Users may wonder which tag is used and how VERSION is resolved. Based on the PR objectives, VERSION is derived from CI tag refs (refs/tags/*) first, falling back to git describe --dirty. Consider briefly mentioning this resolution order or linking to docs/cli/push.md for details.
📝 Suggested clarification
-- `--build` runs `docker buildx build` first, injecting `VERSION` from the tag
- into the build and then pushing both version and `latest` tags. This requires
+- `--build` runs `docker buildx build` first, injecting `VERSION` (determined
+ from CI tag refs or `git describe`) into the build and then pushing both
+ version and `latest` tags. This requires
Docker with Buildx; a Podman-only setup is not supported for `--build`.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - `--build` runs `docker buildx build` first, injecting `VERSION` from the tag | |
| into the build and then pushing both version and `latest` tags. This requires | |
| - `--build` runs `docker buildx build` first, injecting `VERSION` (determined | |
| from CI tag refs or `git describe`) into the build and then pushing both | |
| version and `latest` tags. This requires |
🤖 Prompt for AI Agents
In `@docs/getting-started.md` around lines 148 - 149, Update the `--build`
description to explicitly state how VERSION is resolved: explain that VERSION is
taken from CI tag refs (refs/tags/*) when present, and otherwise falls back to
the output of `git describe --dirty`; also add or reference the
`docs/cli/push.md` link for full resolution details so users know which
tag/source determines VERSION.
1 participant
Summary
refs/tags/*, GitHub/GitLab/Azure envs) before local git fallbackVERSIONinto the docker build environment duringgordon push --buildand forward it with--build-arg VERSIONSummary by CodeRabbit
New Features
--tokenoption for remote authentication in the CLI push command.Improvements
git describe --dirty.--tagand--buildhelp text updated; builds now inject aVERSIONenv var and useVERSIONas a build arg key.Documentation
Tests