style: restructure makefile #4

Merged

mvhutz merged 6 commits from style/makefile-check into main 2026-03-19 00:14:55 +00:00

Conversation 0 Commits 6 Files Changed 2

+45 -18

mvhutz commented 2026-03-18 23:31:57 +00:00

Owner

Copy Link

Copy Source

Currently, the Makefile is not well structured, and does not follow best practices. With the help of checkmake, the Makefile can be forced to follow them.

Decisions

• Added CI job lint-makefile, which forces the Makefile to conform to standards.
• The make help was set as the default target. This is common practice in the industry.
• The make help uses grep | awk to create a command table from ## comments after each target. It seems a bit icky, but it is something that Docker, Kubernetes, and Helm all do.

Currently, the `Makefile` is not well structured, and does not follow best practices. With the help of [`checkmake`](https://github.com/checkmake/checkmake), the Makefile can be forced to follow them. ### Decisions - Added CI job `lint-makefile`, which forces the Makefile to conform to standards. - The `make help` was set as the default target. This is common practice in the industry. - The `make help` uses `grep` | `awk` to create a command table from `##` comments after each target. It seems a bit icky, but it is something that Docker, Kubernetes, and Helm all do.

mvhutz added 4 commits 2026-03-18 23:31:58 +00:00

feat: modernize Makefile ... a367c10957

- Added `checkmake` to enforce good `Makefile` format.
- Added `help`, `test`, `lint-markdown`, `lint`, `clean`, and `all` targets.
- Added `install` target.
- Added target comments to streamline `help` command.

fix: add lint job ... f4b12598f1

Runs all `lint-*` jobs.

fix: add lint to .PHONY e53ff4f50b

refactor: use make in CI, pull module in make docs ... 5c019baa78

Instead of duplicating test logic in both the CI and the Makefile, I made the CI call the Makefile. Also, updated `make docs` so it dynamically pulls the module name from `go list -m`.

mvhutz added 1 commit 2026-03-18 23:34:58 +00:00

fix: unit-test CI job calls 'name' instead of make ... 72a8a9c4f7

I made a typo.

mvhutz added 1 commit 2026-03-19 00:01:30 +00:00

style: rename CI jobs to match Makefile targets 51930a7cbb

mvhutz marked the pull request as ready for review 2026-03-19 00:13:41 +00:00

mvhutz merged commit ece10585a5 into main 2026-03-19 00:14:55 +00:00

mvhutz deleted branch style/makefile-check 2026-03-19 00:14:55 +00:00

mvhutz referenced this issue from a commit 2026-03-19 00:14:57 +00:00

style: restructure makefile (#4)

Sign in to join this conversation.

Reviewers

No Reviewers

Labels

Clear labels

bug

Something is not working

duplicate

This issue or pull request already exists

enhancement

New feature

help wanted

Need some help

invalid

Something is wrong

question

More information is needed

wontfix

This won't be fixed

No labels

Milestone

No items

No Milestone

Assignees

Clear assignees

mvhutz (Maxim Hutz)

No Assignees

1 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: tools/go-cuckoo#4