-
Notifications
You must be signed in to change notification settings - Fork 41
Open
Labels
enhancementNew feature or requestNew feature or request
Description
Problem
Currently, Makefile quality validation is only executable via GitHub Actions (.github/workflows/makefile-quality.yml). This makes it difficult for developers to:
- Run validation locally before pushing
- Test Makefile changes without creating a PR
- Debug validation failures that only show up in CI
As noted by @cgwalters in PR #367:
In projects I work on I try really hard to stick to a core principle that the GHA flows are "just" invoking things in a Justfile (or Makefile). It's ironic that this is about verifying a Makefile, but it's hard to execute outside of GHA.
Proposed Solution
Refactor the validation logic into a local make self-validate target that:
- Checks for required targets (currently done by GHA workflow)
- Validates phony declarations (currently done by GHA workflow)
- Checks target documentation (currently done by GHA workflow)
- Can be run locally before committing changes
The GHA workflow would then simply invoke:
make self-validate
Benefits
- Faster feedback loop for developers
- Consistent behavior between local and CI
- Easier to debug validation failures
- Follows best practice of "CI runs what developers can run"
- Reduces GHA-specific logic
Current Workaround
Developers must push to a branch and wait for GHA to run, which slows down iteration.
Related
- Introduced in PR feat: Local Dev with MiniKube #246 / feat: Local Dev with MiniKube (revised) #367 (Minikube migration)
- Review comment: feat: Local Dev with MiniKube (revised) #367 (comment)
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or request