DEV Community

Cover image for Use a help target in your Makefile
Joris Conijn for AWS Community Builders

Posted on • Originally published at binx.io

4

Use a help target in your Makefile

In one of my previous blog. I wrote how you could make your life easier when you start using Makefile. But when you start using Makefile in many projects. The targets that you use may vary from project to project.

In this blog post I will address a trick how you could write a help target. Lets imagine that we have a project that allow you to build, start and stop a docker container. These names are pretty straightforward. But without looking in the Makefile you never know for sure.

By calling the help target you could list all available targets:

make help
Enter fullscreen mode Exit fullscreen mode

All targets are listed with a help text

When you have a look at the Makefile used for this blog post. It looks like this:

.DEFAULT_GOAL:=help
.PHONY: help
help:  ## Display this help
    $(info Example Makefile for my blog post)
    awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z0-9_-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)

.PHONY: build
build: ## Build the container image
    docker build -t my-container:latest .

.PHONY: stop
stop: ## Stop the container
    docker stop my-named-container > /dev/null 2>&1 || True
    docker rm my-named-container > /dev/null 2>&1 || True

.PHONY: start
start: stop ## Start the container
    docker run --name my-named-container my-container:latest > /dev/null

.PHONY: shell
shell: ## Start a shell session on the container
    docker run -it my-named-container:latest bash

.PHONY: logs
logs: ## Tail the logs of the running container
    docker logs my-named-container -f

$(VERBOSE).SILENT:
Enter fullscreen mode Exit fullscreen mode

You need to add the help target. And for each target you need to supply a help text. And each target needs a prefix with ##.

By adding a help target to your Makefile you make it easier to use for others. But also for yourself because you don't need to remember each target in the Makefile.

Photo by lalesh aldarwish

Image of Timescale

🚀 pgai Vectorizer: SQLAlchemy and LiteLLM Make Vector Search Simple

We built pgai Vectorizer to simplify embedding management for AI applications—without needing a separate database or complex infrastructure. Since launch, developers have created over 3,000 vectorizers on Timescale Cloud, with many more self-hosted.

Read more

Top comments (0)

Best Practices for Running  Container WordPress on AWS (ECS, EFS, RDS, ELB) using CDK cover image

Best Practices for Running Container WordPress on AWS (ECS, EFS, RDS, ELB) using CDK

This post discusses the process of migrating a growing WordPress eShop business to AWS using AWS CDK for an easily scalable, high availability architecture. The detailed structure encompasses several pillars: Compute, Storage, Database, Cache, CDN, DNS, Security, and Backup.

Read full post