Skip to content

pitfalls.md

Latest commit

 

History

History
17 lines (9 loc) · 1.54 KB

pitfalls.md

File metadata and controls

17 lines (9 loc) · 1.54 KB
Raw

Common Pitfalls

  1. Forgetting to regenerate docs. Any change to a command, flag, or help string must be followed by make docs. CI runs make check-docs, which regenerates and fails if git status is dirty. This is the most common CI failure.

  2. Vendoring drift. Dependencies are vendored (vendor/ is committed). After go get/go mod changes you must run go mod tidy && go mod vendor, or the build/CI breaks. Do not hand-edit vendor/.

  3. Stale mocks. Mocks in internal/auth0/mock are generated by mockgen. After changing a mocked interface, run make test-mocks — do not hand-edit the generated files.

  4. Two go-auth0 major versions coexist. The repo imports both github.com/auth0/go-auth0 (v1, management) and github.com/auth0/go-auth0/v2. Check which version a given command already uses before adding calls; don't mix types across the two.

  5. Printing results directly. Use the internal/display renderer instead of fmt.Println so --json and format flags keep working, and so nothing accidentally prints a secret.

  6. Leaking secrets in output/logs. Client secrets and tokens live in the OS keyring (internal/keyring). Never log them; secret-revealing output (e.g. --reveal-secrets) must be explicit and opt-in.

  7. Enabling telemetry/crash reporting for dev builds. Both analytics and Sentry intentionally no-op when buildinfo.Version is empty or dev. Don't remove those guards.

  8. godot lint failures. Comments must be complete sentences ending in a period — an easy lint miss on new code.