Bryan Beverly
4d2a8ef686
* Add man page generation for trufflehog Add a hidden --generate-man-page flag that uses an enhanced Kingpin template to produce a standards-compliant roff man page. The man page includes auto-generated OPTIONS and COMMANDS sections (synced with the CLI definitions), plus hand-maintained EXAMPLES, EXIT STATUS, ENVIRONMENT, FILES, BUGS, and SEE ALSO sections. The DESCRIPTION and EXAMPLES sections call out the interactive TUI that launches when trufflehog is run without a command in a terminal. To keep the generated output deterministic, the --concurrency flag is defined with a static "N" placeholder; the runtime.NumCPU() default is applied at runtime instead of at flag-definition time. The usage line also uses the lowercase binary name. Distribution: - Makefile `man` target to regenerate locally - GoReleaser before hook to regenerate at release time with the correct version injected via ldflags - Release archives explicitly include LICENSE, README.md, and docs/man/trufflehog.1 - Homebrew formula installs the man page to man1 The Makefile `test-release` target is also updated to GoReleaser v2 flag syntax (--skip=publish,sign), which is needed for the snapshot release to succeed locally without cosign installed. Made-with: Cursor * Add man page maintenance guardrails Add a CI job that regenerates the man page on every PR and fails if the checked-in copy at docs/man/trufflehog.1 is out of date with the current CLI definitions. Document the regeneration workflow in CONTRIBUTING.md so contributors know to run `make man` and commit the result when changing flags or subcommands. Made-with: Cursor
71 lines
1.9 KiB
Makefile
71 lines
1.9 KiB
Makefile
PROTOS_IMAGE ?= trufflesecurity/protos:1.22
|
|
|
|
.PHONY: check
|
|
.PHONY: lint
|
|
.PHONY: test
|
|
.PHONY: test-race
|
|
.PHONY: run
|
|
.PHONY: install
|
|
.PHONY: protos
|
|
.PHONY: protos-windows
|
|
.PHONY: vendor
|
|
.PHONY: dogfood
|
|
.PHONY: man
|
|
|
|
dogfood:
|
|
CGO_ENABLED=0 go run . git file://. --json --log-level=2
|
|
|
|
install:
|
|
CGO_ENABLED=0 go install .
|
|
|
|
check:
|
|
go fmt $(shell go list ./... | grep -v /vendor/)
|
|
go vet $(shell go list ./... | grep -v /vendor/)
|
|
|
|
lint:
|
|
./scripts/lint.sh
|
|
|
|
test-failing:
|
|
CGO_ENABLED=0 go test -timeout=5m $(shell go list ./... | grep -v /vendor/) | grep FAIL
|
|
|
|
test:
|
|
CGO_ENABLED=0 go test -timeout=5m $(shell go list ./... | grep -v /vendor/)
|
|
|
|
test-integration:
|
|
CGO_ENABLED=0 go test -timeout=5m -tags=integration $(shell go list ./... | grep -v /vendor/)
|
|
|
|
test-race:
|
|
CGO_ENABLED=1 go test -timeout=5m -race $(shell go list ./... | grep -v /vendor/)
|
|
|
|
test-detectors:
|
|
CGO_ENABLED=0 go test -tags=detectors -timeout=5m $(shell go list ./... | grep pkg/detectors)
|
|
|
|
test-community:
|
|
CGO_ENABLED=0 go test -timeout=5m $(shell go list ./... | grep -v /vendor/ | grep -v pkg/sources | grep -v pkg/analyzer/analyzers)
|
|
|
|
bench:
|
|
CGO_ENABLED=0 go test $(shell go list ./pkg/secrets/... | grep -v /vendor/) -benchmem -run=xxx -bench .
|
|
|
|
run:
|
|
CGO_ENABLED=0 go run . git file://. --json
|
|
|
|
run-debug:
|
|
CGO_ENABLED=0 go run . git file://. --json --log-level=2
|
|
|
|
protos:
|
|
docker run --rm -u "$(shell id -u)" -v "$(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))":/pwd "${PROTOS_IMAGE}" bash -c "cd /pwd; /pwd/scripts/gen_proto.sh"
|
|
|
|
protos-windows:
|
|
docker run --rm -v "$(shell cygpath -w $(shell pwd))":/pwd "${PROTOS_IMAGE}" bash -c "cd /pwd; ./scripts/gen_proto.sh"
|
|
|
|
release-protos-image:
|
|
docker buildx build --push --platform=linux/amd64,linux/arm64 \
|
|
-t ${PROTOS_IMAGE} -f hack/Dockerfile.protos .
|
|
|
|
man:
|
|
@mkdir -p docs/man
|
|
CGO_ENABLED=0 go run . --generate-man-page > docs/man/trufflehog.1
|
|
|
|
test-release:
|
|
goreleaser release --clean --skip=publish,sign --snapshot
|