Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Add flag for reading binary version

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

A pull request for this has already been merged.

  • #78 by @airycanon — merged

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
55/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Stale
Tech stack
go
Domain
cli

Research direction

Start at the crd-ref-docs CLI entry point and review the Makefile example alongside the version lookup in tools/go.mod. Add the --version behavior so the command reports the version expected by the grep check, then verify the command and install/version comparison flow.

Written by the indexing model from the issue text.

Description

enhancement

It would be nice to be able to get the version of the binary through a flag eg. crd-ref-docs --version. We rely on doing this in order to ensure that our team uses the right versions of binaries. We would like to be able to do something like this in our Makefile:

CRD_REF_DOCS ?= $(TOOLSBIN)/crd-ref-docs
CRD_REF_DOCS_GO_MOD_VERSION ?= $(shell cat tools/go.mod | grep -E "github.com/elastic/crd-ref-docs" | cut -d ' ' -f2)

.PHONY: crd-ref-docs
crd-ref-docs: ## 📦 Download crd-ref-docs locally if necessary.
	(test -s $(CRD_REF_DOCS) && \
	$(CRD_REF_DOCS) --version | grep $(CRD_REF_DOCS_GO_MOD_VERSION)) || \
	(cd tools && GOBIN=$(TOOLSBIN) go install github.com/elastic/crd-ref-docs)

This make target will download the binary and install it in ./tools/bin if it doesn't exist or the version doesn't match what we have in the go module in ./tools/go.mod.

Dominant language
Go
Stars
174
Forks
81
No merged PRs in 30d

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 elastic/crd-ref-docs

All issues in elastic/crd-ref-docs

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.