Add a Makefile for convenience - #8491
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #8491 +/- ##
=========================================
Coverage 19.64% 19.65%
- Complexity 19790 19792 +2
=========================================
Files 6368 6368
Lines 574889 574889
Branches 70353 70353
=========================================
+ Hits 112962 112969 +7
+ Misses 449656 449651 -5
+ Partials 12271 12269 -2
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
ah, you are from the makestory :D |
|
looks ok, I'm not sure of the use yet. can you explain the framework in use ; yarn, make. pre-commit? is this only for use in GHA? |
yadvr
left a comment
yadvr
left a comment
There was a problem hiding this comment.
-1 - we've GitHub actions for this, and I don't expect people to run it manually on their systems.
|
This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch. |
I actually would expect seasoned developers to run this depending on the kind of changes they are making. that is to say the checks. if we add them to the pom file somehow that could work as well. |
|
This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch. |
|
Hi @jbampton is this PR ready for review or is it still in progress? |
There was a problem hiding this comment.
Pull request overview
Adds a repository-root Makefile to provide a simple local developer entrypoint for common pre-commit workflows, complementing the existing pre-commit documentation and CI workflow.
Changes:
- Introduces
make checkto runpre-commitagainst all files. - Adds
make checkinstallto install the git hook scripts. - Adds
make checkupdateto autoupdate pre-commit hook revisions.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
Thanks @jbampton Hi @yadvr @DaanHoogland can you please have a second review on this PR? |
I feel that any make mechs since make are an abundance. We have choosen for maven and I’ll honour that, but providing a makefile by someone who wants it for someone who wants it should never be blocked. (in case not clear: a big plusone on this) |
| # under the License. | ||
|
|
||
| check : | ||
| pre-commit run --all-files |
There was a problem hiding this comment.
Tested this locally. CI runs pre-commit twice, the second with --hook-stage manual. This is only the first, so the chmod hook never runs locally. Should check run both, or should the manual one be its own target?
| .PHONY : check | ||
|
|
||
| checkinstall : | ||
| pre-commit install |
There was a problem hiding this comment.
checkinstall only writes .git/hooks/pre-commit. The config sets default_stages: [pre-commit, pre-push], so the pre-push hook never gets installed. Worth adding --hook-type pre-commit --hook-type pre-push?
| .PHONY : checkinstall | ||
|
|
||
| checkupdate : | ||
| pre-commit autoupdate |
There was a problem hiding this comment.
Ran this and it rewrote .pre-commit-config.yaml, bumping four pins (doctoc, oxipng, codespell, markdownlint). Exits 0 with no sign it touched a tracked file. Can we note that in a comment here?
| # specific language governing permissions and limitations | ||
| # under the License. | ||
|
|
||
| check : |
There was a problem hiding this comment.
Bare make runs check, since it is the first target. Works, but should we set .DEFAULT_GOAL and add a help target? The three names do not say much on their own.
|
None of the targets check that pre-commit exists, so you just get "make: pre-commit: No such file or directory". Worth a guard? |
https://pre-commit.com/#4-optional-run-against-all-the-files
https://pre-commit.com/#3-install-the-git-hook-scripts
https://pre-commit.com/#pre-commit-autoupdate
Description
The Makefile will contain the three main commands for using pre-commit locally.
At least this gives you a quickstart and place to see and run the pre-commit commands.
Makefiles can be very handy perhaps in future more commands can be added.
https://en.wikipedia.org/wiki/Make_(software)
refs apache/sedona#1183
Types of changes
Feature/Enhancement Scale or Bug Severity
Feature/Enhancement Scale
Bug Severity
Screenshots (if appropriate):
How Has This Been Tested?
How did you try to break this feature and the system with this change?