Add a more self-contained pre-commit hook #155
Merged
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
The previous `pre-commit` hook declaration, using `language: 'script'`, relied on `woke` already being installed on the user's path, which is a somewhat awkward requirement compared to most other `pre-commit` hooks which tend to be self-contained. It also meant that it wasn't possible to pin `woke` to a particular version on a per-repository basis using something like `rev: v0.15.0`. Using `language: 'golang'` instead means that `pre-commit` builds a self-contained installation of `woke` for itself. The only downside is that the `go` binary on the user's path must be at least version 1.17, which can be a bit annoying (for example, on Ubuntu 20.04 it requires using something like the `go` snap rather than the .deb). However, this will become less of a problem over time. In order to avoid a breaking change for people already using the old approach, I added this as a new alternative hook, called `woke-from-source`. Add documentation for all this.
3 tasks
caitlinelfring
approved these changes
Nov 5, 2021
Closed
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.
Please check if the PR fulfills these requirements
What kind of change does this PR introduce?
New alternative
pre-commithook, and corresponding documentation.What is the current behavior? (You can also link to an open issue here)
The previous
pre-commithook declaration, usinglanguage: 'script', relied onwokealready being installed on the user's path, which is a somewhat awkward requirement compared to most otherpre-commithooks which tend to be self-contained. It also meant that it wasn't possible to pinwoketo a particular version on a per-repository basis using something likerev: v0.15.0.What is the new behavior (if this is a feature change)?
Using
language: 'golang'instead means thatpre-commitbuilds a self-contained installation ofwokefor itself. The only downside is that thegobinary on the user's path must be at least version 1.17, which can be a bit annoying (for example, on Ubuntu 20.04 it requires using something like thegosnap rather than the .deb). However, this will become less of a problem over time.In order to avoid a breaking change for people already using the old approach, I added this as a new alternative hook, called
woke-from-source.Add documentation for all this.
Does this PR introduce a breaking change? (What changes might users need to make due to this PR?)
No - the previous hook is left unchanged. Users may wish to migrate to the new hook if it fits their needs better.
This is an alternative to #152.