README.md

Common scripts

Common scripts and reusable GitHub actions and workflows.

This repository is intended to be used as git submodule.

Basic project structure

Basic structure that uses this repository as a git submodule becomes

/                   |-- Project root
├─ _scripts/        |-- Git submodule (This repository)
│  └─ makefiles/    |
├─ makefiles/       |-- Projects' makefiles
├─ docs/            |-- Documentation
├─ cmd/             |-- Go commands
├─ go.mod           |
├─ go.sum           |
└─ Makefile         |-- Include necessary *.mk

./Makefile is an example of project's makefile.

To use this this repository

1. git submodule add https://github.com/aileron-projects/_scripts.git
2. Create project makefile (See ./Makefile for example).
3. Commit changes.

Makefiles

Reusable makefiles are placed in ./makefiles/. Currently following tools available.

Makefile	Help commands	Description
cspell.mk	make cspell-help	Run spell check with cspell
drawio.mk	make drawio-help	Export images from *.drawio
go-build.mk	make go-build-help	Build go applications
go-licenses.mk	make go-licenses-help	Run license checks
go-test.mk	make go-test-help	Run go testing
go.mk	make go-help	Run plain go command
goda.mk	make goda-help	Generate dependency graph
golangci-lint.mk	make golangci-lint-help	Lint with golangci-lint
govulncheck.mk	make govulncheck-help	Run vulnerability check
graphviz.mk	make graphviz-help	Export images from *.dot
markdownlint.mk	make markdownlint-help	Lint with markdownlint
mermaid.mk	make mermaid-help	Export images from *.mmd
nfpm.mk	make nfpm-help	Generate linux package with nfpm
plantuml.mk	make plantuml-help	Export images from *.puml
prettier.mk	make prettier-help	Lint and format with prettier
scanoss.mk	make scanoss-help	Check copyright health
shellcheck.mk	make shellcheck-help	Lint shells
shfmt.mk	make shfmt-help	Format shells
trivy.mk	make trivy-help	Run trivy (Generate SBOM)
util.mk	make util-help	Some utilities

make list shows the loaded makefiles.

$ make list
Makefile
makefiles/cspell.mk
makefiles/drawio.mk
makefiles/go-build.mk
makefiles/go-licenses.mk
makefiles/go-test.mk
makefiles/go.mk
makefiles/goda.mk
makefiles/golangci-lint.mk
makefiles/govulncheck.mk
makefiles/graphviz.mk
makefiles/markdownlint.mk
makefiles/mermaid.mk
makefiles/nfpm.mk
makefiles/plantuml.mk
makefiles/prettier.mk
makefiles/scanoss.mk
makefiles/shellcheck.mk
makefiles/shfmt.mk
makefiles/trivy.mk
makefiles/util.mk

make help shows the help rules.

$ make help
Help Commands
-------------
make cspell-help
make drawio-help
make go-build-help
make go-licenses-help
make go-test-help
make go-help
make goda-help
make golangci-lint-help
make govulncheck-help
make graphviz-help
make markdownlint-help
make mermaid-help
make nfpm-help
make plantuml-help
make prettier-help
make scanoss-help
make shellcheck-help
make shfmt-help
make trivy-help
make util-help

GitHub Actions

Reusable actions in ./.github/actions/.

Reusable actions in ./.github/workflows/.

Make command tips

Following make options can be helpful when debugging make.

See also the 9.8 Summary of Options.

Make option	Usage	Description
--help	make --help	Show help message of the make command itself.
-W file	make -W foo.txt TARGET	Pretend that the target file has just been modified.
-n	make -n TARGET	Print the recipe that would be executed, but do not execute it.
-p	make -p TARGET	Print rules and variable that are read from makefiles.
-d	make -d TARGET	Print debugging information in addition to normal processing.
--trace	make --trace TARGET	Show tracing information. Short for --debug=print,why.

Additionally, MAKEFLAGS can be used to persist the options. For example,

$ export MAKEFLAGS="--trace"
$ make TARGET

# is identical to

$ make --trace TARGET