precheck

name	precheck
description	Run pre-commit checks (gofmt, goimports, gazelle, code generators, build) before committing Prysm changes. Required before every commit.

Pre-commit checks

Run these in order from the repo root before every commit. Stop and report if any step fails.

1. gofmt — format changed Go files:

   gofmt -l $(git diff --name-only --diff-filter=ACM HEAD | grep '\.go$')
   

   If output is non-empty, run gofmt -w on those files.

2. goimports — organize imports:

   goimports -l $(git diff --name-only --diff-filter=ACM HEAD | grep '\.go$')
   

   If output is non-empty, run goimports -w on those files.

3. Gazelle — sync deps.bzl (when go.mod changed):

   bazel run //:gazelle -- update-repos -from_file=go.mod -to_macro=deps.bzl%prysm_deps -prune=true
   git diff --exit-code deps.bzl
   

4. Gazelle — sync BUILD.bazel:

   bazel run //:gazelle -- fix --mode=diff
   

   If the diff is non-empty, run bazel run //:gazelle -- fix.

5. Regenerate code (when .proto, SSZ-tagged structs, or proto service interfaces changed):

   make gen
   

   Regenerates proto/ssz/mocks and runs goimports+gofmt on the generated files. It's cached; if unsure which files changed, bypass the cache with . Limit to one kind with e.g. .