Skip to content

Commit

Permalink
round out local Makefile checks
Browse files Browse the repository at this point in the history
by collecting them and adding hlint. Other checks will follow, e.g.
API checking once that lands.
  • Loading branch information
geekosaur committed Oct 4, 2024
1 parent 24a128e commit fa3b475
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <test-target>` 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
Expand Down
7 changes: 7 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit fa3b475

Please sign in to comment.