Commit Graph

4 Commits

Author SHA1 Message Date
e305b9c3c2 style: rename "Lint Makefile" to "Makefile Lint"
All checks were successful
CI / Makefile Lint (pull_request) Successful in 15s
CI / Go Lint (pull_request) Successful in 18s
CI / Unit Tests (pull_request) Successful in 29s
CI / Fuzz Tests (pull_request) Successful in 46s
CI / Mutation Tests (pull_request) Successful in 36s
This matches the convention of the other CI job names.
2026-03-18 20:21:51 -04:00
e712c7ad79 ci: add lint makefile job
All checks were successful
CI / Lint Makefile (pull_request) Successful in 22s
CI / Go Lint (pull_request) Successful in 16s
CI / Unit Tests (pull_request) Successful in 12s
CI / Mutation Tests (pull_request) Successful in 36s
CI / Fuzz Tests (pull_request) Successful in 55s
Currently, there is no CI job to lint the Makefile. This adds one.
2026-03-18 20:19:27 -04:00
ece10585a5 style: restructure makefile (#4)
All checks were successful
CI / Unit Tests (push) Successful in 13s
CI / Go Lint (push) Successful in 17s
CI / Mutation Tests (push) Successful in 33s
CI / Fuzz Tests (push) Successful in 58s
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.

Reviewed-on: #4
Co-authored-by: M.V. Hutz <git@maximhutz.me>
Co-committed-by: M.V. Hutz <git@maximhutz.me>
2026-03-19 00:14:54 +00:00
0017a33f12 ci: clean up workflow (#3)
All checks were successful
CI / Unit Tests (push) Successful in 35s
CI / Golang Lint (push) Successful in 1m1s
CI / Fuzz Tests (push) Successful in 1m18s
CI / Mutation Tests (push) Successful in 1m12s
## Description

The current CI workflow was auto-generated by Claude, and is really not intuitive. Fixing it up to make it work better.

- Add names for jobs in workflow.
- Rename workflow to `ci.yml`.
- Added `go mod tidy` as a tasks in the `lint` job.

### Decisions

- Chose not to use emojis for workflow or job names. While they look nice, they are unprofessional, and harder to `grep`.

Reviewed-on: #3
Co-authored-by: M.V. Hutz <git@maximhutz.me>
Co-committed-by: M.V. Hutz <git@maximhutz.me>
2026-03-18 00:47:02 +00:00