Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

dev: Add Makefile with common commands #516

Merged
merged 1 commit into from
Dec 14, 2022
Merged

dev: Add Makefile with common commands #516

merged 1 commit into from
Dec 14, 2022

Conversation

tonyo
Copy link
Contributor

@tonyo tonyo commented Dec 13, 2022

We can later update CONTRIBUTING.md and Actions workflows to use "make" targets as the source of truth.

We can later update CONTRIBUTING.md and Actions workflows to use "make"
targets as the source of truth.

# Parse Makefile and display the help
help: ## Show help
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A bit of magic to auto-generate usage docs for make targets:

image

Credits go to https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html

@tonyo tonyo requested a review from cleptric December 13, 2022 10:48
Copy link
Member

@cleptric cleptric left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

@tonyo tonyo merged commit 84f883b into master Dec 14, 2022
@tonyo tonyo deleted the build/add-makefile branch December 14, 2022 09:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants