Skip to content

Commit

Permalink
docs: add updating hook versions section
Browse files Browse the repository at this point in the history
  • Loading branch information
dgschwindturo committed Sep 11, 2023
1 parent a5dbb1a commit 72ce75f
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ in this example, some of the hooks enabled would be redundant.
```yaml
repos:
- repo: https://github.com/turo/pre-commit-hooks
rev: v2.0.0 # You may version pin this if desired
rev: v3.0.0 # You may version pin this if desired
hooks:
- id: go-test-unit
- id: go-build
Expand Down Expand Up @@ -103,7 +103,7 @@ A typical `pre-commit-config.yaml` for a Golang project would look like this:
```yaml
repos:
- repo: https://github.com/turo/pre-commit-hooks
rev: v2.0.0 # You may version pin this if desired
rev: v3.0.0 # You may version pin this if desired
hooks:
- id: go-mod-tidy # Clean up go.mod
- id: go-build # Check compilation
Expand All @@ -112,6 +112,12 @@ repos:
- id: gomarkdoc # Generate documenation
```

## Updating hook versions

The version of the hook, e.g. `golangci-lint`, that is actually used by this Action may be made available
via instructions in the `packer-github-actions-general` GitHub repository. Thus, please refer to
that repository to upgrade any specific hook version.

## Contributing

Feel free to Pull Request this repository to add any commonly used hooks which
Expand Down

0 comments on commit 72ce75f

Please sign in to comment.