Skip to content

Feature/Makefile help target#125

Merged
mattyjones merged 1 commit intoN0MoreSecr3ts:developfrom
shreyas-sriram:make-help
Jul 8, 2022
Merged

Feature/Makefile help target#125
mattyjones merged 1 commit intoN0MoreSecr3ts:developfrom
shreyas-sriram:make-help

Conversation

@shreyas-sriram
Copy link
Copy Markdown
Contributor

@shreyas-sriram shreyas-sriram commented Jun 23, 2022

Summary

This commit enables make help to automatically print available make targets based off the comments for each target in the Makefile.

The default make target is also set to help.

The definition for each target can be changed.

Sample Output

$ make     

Available make targets:

	all		Run lint tools, clean and build
	build		Download dependencies and build
	release		Download dependencies and build release binaries
	clean		Clean binaries
	help		Print available make targets
	install		Build and save binary in `$GOPATH/bin/`
	package		Run tests, clean and build binary
	prep		Install dependencies
	pretty		Run golint, go fmt and go vet
	test		Run tests with coverage
$ make help

Available make targets:

	all		Run lint tools, clean and build
	build		Download dependencies and build
	release		Download dependencies and build release binaries
	clean		Clean binaries
	help		Print available make targets
	install		Build and save binary in `$GOPATH/bin/`
	package		Run tests, clean and build binary
	prep		Install dependencies
	pretty		Run golint, go fmt and go vet
	test		Run tests with coverage

@mattyjones mattyjones self-assigned this Jul 8, 2022
@mattyjones mattyjones added Build and Release Testing, Packaging, Release Tooling Documentation Improvements or additions to documentation labels Jul 8, 2022
@mattyjones mattyjones added this to the Milestone 1 milestone Jul 8, 2022
@mattyjones mattyjones merged commit b49b68a into N0MoreSecr3ts:develop Jul 8, 2022
@shreyas-sriram shreyas-sriram deleted the make-help branch July 10, 2022 19:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@mattyjones mattyjones

Labels

Build and Release Testing, Packaging, Release Tooling Documentation Improvements or additions to documentation

Projects

None yet

Milestone

Milestone 1

Development

Successfully merging this pull request may close these issues.

2 participants

@shreyas-sriram @mattyjones