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.

Sign up for GitHub

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

docs: add updating hook versions section #40

Merged
merged 1 commit into from
Sep 11, 2023
Merged

docs: add updating hook versions section #40

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions README.md
View file
Open in desktop
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