help-make-helper

一个小的Python程序，您可以在Makefile中放入以生成花哨的帮助。注意：如果您想知道Python程序在哪里：它在Makefile内部。这个程序意味着在您运行make命令时运行。

动机

构建现代软件需要许多工具。我不能也不愿意一次又一次地记住或输入所有这些命令（docker、npm、terraform、ansible、scss等）。无论您的堆栈是什么样的，Makefile和make命令可以帮助您避免不必要的输入并节省时间。

如果您有一个CI/CD流水线，这也帮助抽象所有阶段，并允许您在本地上运行所有测试、构建和部署阶段。

只需在克隆此存储库后输入make即可！它将打印

$ 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

此make文件解析所有行并检查目标、局部变量和全局变量。如果它们以##或#?结尾，则随后的字符串被解释为目标或变量的帮助。这对于维护大型项目的手动帮助目标来说要好得多。

目标可以用如下方式使用参数

make docker-build IMG=foo TAG=0.1

或

make test COLOR=red HOST=red.example.org