Expose CLI version and build metadata consistently

Open
  • Is something wrong?
#275 3 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

  • #276 by @mynk8 — closed without merging

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
55/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Quiet
Tech stack
go
Domain
build-system, cli

Research direction

Start with the CLI's existing version command and the Makefile, then trace how source, nightly, and release binaries are built. Define the expected version and commit metadata for each build type, and verify that the command reports both consistently for local and tagged builds.

Written by the indexing model from the issue text.

Description

stale
Reason/Context

The CLI version is currently hardcoded and only exposed through the version command. That makes source-built, nightly, and packaged binaries harder to identify when debugging user reports.

Description

Since the project already uses a Makefile, the build system can inject version and commit metadata at build time. This keeps release binaries tied to their Git tag, while still making local/source builds identifiable by commit.

Something like having

Microcks CLI 1.0.2-43-g1dad150-dirty
Commit: 1dad150

for the local builds

and for release builds which are sourced from the release tags

Microcks CLI 1.0.3
Commit: 1dad150
Dominant language
Go
Stars
59
Forks
74
Avg merge
4d 5h
Merged PRs (30d)
15

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from microcks/microcks-cli

All issues in microcks/microcks-cli

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.