Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve pre commit hook: make it block hlint issues #296

Merged
merged 2 commits into from
Sep 20, 2023

Conversation

smelc
Copy link
Contributor

@smelc smelc commented Sep 20, 2023

Changelog

- description: |
    Update to the pre-commit script, so that it fails on hlint errors
# uncomment types applicable to the change:
  type:
  # - feature        # introduces a new feature
  # - breaking       # the API has changed in a breaking way
  # - compatible     # the API has changed but is non-breaking
  # - optimisation   # measurable performance improvements
  - improvement    # QoL changes e.g. refactoring
  # - bugfix         # fixes a defect
  # - test           # fixes/modifies tests
  # - maintenance    # not directly related to the code
  # - release        # related to a new release preparation
  # - documentation  # change in code docs, haddocks...

Context

Fixes #294

How to trust this PR

  1. Try the procedure described in Pre-commit hook doesn't fail on hlint failure #294.
  2. Witness that the git commit -m "try commit" step now fails

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • The change log section in the PR description has been filled in
  • NA New tests are added if needed and existing tests are updated. These may include:
    • golden tests
    • property tests
    • round trip tests
    • integration tests
      See Running tests for more details
  • NA The version bounds in .cabal files are updated
  • CI passes. See note on CI. The following CI checks are required:
    • Code is linted with hlint. See .github/workflows/check-hlint.yml to get the hlint version
    • Code is formatted with stylish-haskell. See .github/workflows/stylish-haskell.yml to get the stylish-haskell version
    • Code builds on Linux, MacOS and Windows for ghc-8.10.7 and ghc-9.2.7
  • NA The changelog section in the PR is updated to describe the change
  • Self-reviewed the diff

@smelc smelc added the enhancement New feature or request label Sep 20, 2023
@smelc smelc changed the title Smelc/improve pre commit hook Improve pre commit hook: make it block hlint issues Sep 20, 2023
Copy link
Contributor

@carbolymer carbolymer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome! Thanks. We have the same hook in the same place in cardano-node and cardano-api also. Can you migrate the changes there as well?

@smelc
Copy link
Contributor Author

smelc commented Sep 20, 2023

Awesome! Thanks. We have the same hook in the same place in cardano-node and cardano-api also. Can you migrate the changes there as well?

@carbolymer> on my way 👍

@smelc smelc force-pushed the smelc/improve-pre-commit-hook branch from ba45937 to 1fbafcc Compare September 20, 2023 13:08
@smelc smelc added this pull request to the merge queue Sep 20, 2023
Merged via the queue into main with commit 5ad8d69 Sep 20, 2023
19 checks passed
@smelc smelc deleted the smelc/improve-pre-commit-hook branch September 20, 2023 16:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Pre-commit hook doesn't fail on hlint failure
2 participants