From 05e939de2964153aa44da3cd7c86d8d8b5a475e6 Mon Sep 17 00:00:00 2001 From: brandon s allbery kf8nh Date: Thu, 3 Oct 2024 20:35:47 -0400 Subject: [PATCH] round out local Makefile checks by collecting them and adding hlint. Other checks will follow, e.g. API checking once that lands. --- CONTRIBUTING.md | 7 +++++++ Makefile | 7 +++++++ 2 files changed, 14 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 93835320bb2..f2e28f2e069 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -157,6 +157,13 @@ For these test executables, `-p` which applies a regex filter to the test names. When running `cabal-install` test suites, one need only use `cabal test` or `cabal run ` in order to test locally. +## Running other checks locally + +Various other checks done by CI can be run locally to make sure your code doesn't +fail annoyingly once you push it. `make checks` will do these checks. The list of +checks is expected to grow over time, to make it easier to avoid CI turnaround on +simple problems. + ## QA Notes Manual Quality Assurance (QA) is performed to ensure that the changes impacting diff --git a/Makefile b/Makefile index 12d38557de6..5cf1cae4d6f 100644 --- a/Makefile +++ b/Makefile @@ -49,6 +49,13 @@ whitespace: ## Run fix-whitespace in check mode fix-whitespace: ## Run fix-whitespace in fix mode fix-whitespace --verbose +# local checks + +.PHONY: checks +checks: whitespace style + # this should probably be a rule + hlint -j --json -- . + # source generation: SPDX SPDX_LICENSE_HS:=Cabal-syntax/src/Distribution/SPDX/LicenseId.hs