Support running Copywrite as a pre-commit hook via .pre-commit-hooks.yaml #24
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
CalebAlbers
changed the title
Closed
randyhdev
approved these changes
Feb 2, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🛠️ Description
Fixes #8
Adds a
.pre-commit-hooks.yamlfile, defining a set of four common hooks that can be used to validate or add headers and theLICENSEfile. This empowers people to run thecopywritetooling as part of their regular pre-commit workflow.Side note on technical implementation - I decided to try using the
golanglanguage support, in which pre-commit will automatically setup a Go environment, clone this repo, and usego run .as the entry. Ideally, we'd use the nativecopywritebinaries, but that would require anyone using the hooks to have bootstrapped their environment before-hand. This can always be adjusted or changed in the future.🔗 External Links
https://hashicorp.atlassian.net/browse/ENGSYS2-534
🤔 Can be merged upon approval?
✅