Help menus generator for Makefiles
Project description
help-make-helper
A small python program you put in your Makefile to produce fancy help
NOTE: in case you wonder, where the Python program is: it's inside the Makefile.
This program is meant to run when you run the command make
.
Motivation
Building modern software requires a lot of tools. I can't and I don't want
to memorize or type all these commands over and over again (docker, npm,
terraform, ansible, scss, etc). What ever your stack looks like, Makefile
and the make
command help you avoid unnecessary typing and save time.
If you have a CI\CD pipeline this also help abstract all the stages and allows you to run all the test, build and deploy phases locally.
Just type make
after cloning this repo! It will print:
$ make
Targets:
test test that the HOST shows background COLOR
HOST - what host is running NGinx
COLOR - which color should be the backround
docker-build build a docker image
docker-push push docker image to $(REGISTRY)
Global Variables you can override:
VERSION version
REGISTRY container registry to push
ORG organization to push to
IMG image name
OPTS add extra OPTS to misc commands
This make file parses all the lines and checks for target, local variables
and global variables.
If they are suffixed with ##
or #?
the string that follows is interpreted
as the help for that variable or target.
This is much better then maintaining a help target manually for larger
projects.
The targets can be used with parameters like this:
make docker-build IMG=foo TAG=0.1
Or:
make test COLOR=red HOST=red.example.org
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file make-help-helper-0.1.1.tar.gz
.
File metadata
- Download URL: make-help-helper-0.1.1.tar.gz
- Upload date:
- Size: 3.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.1
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6fdbc9eaac9f13d4723a04d3a9cc35e8d985419a83c9de44a3a0e13b37990b0a |
|
MD5 | 483c772f9b1bd6e7c9ed94d314e03b58 |
|
BLAKE2b-256 | 57d0d72afc03409b47866e111f81aaaef59166e587f393afd0acbdbf49ff1bcc |