Repository navigation
feat: add lefthook pre-commit hook with gitleaks secret scanning - #313
Merged
Merged
Conversation
Part of the Git Hooks RFC rollout (bcgov/entity#34619). Adds a hooks-only root package.json (no app code at root) that installs lefthook, which runs gitleaks against staged changes on commit. prepare skips lefthook when git is absent and works under both cmd.exe and POSIX sh. lefthook's own postinstall is disabled via allowBuilds in pnpm-workspace.yaml since prepare handles installation. documents-common/layers/base had no pnpm-workspace.yaml of its own, so pnpm would resolve the new root one as its workspace and install nothing there. Give it its own (packages: []) so it stays a standalone project.
pwei1018
approved these changes
Oct 1, 2026
This was referenced Oct 1, 2026
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Part of the Git Hooks RFC rollout (bcgov/entity#34619).
Adds a pre-commit hook that runs gitleaks on staged changes, same setup as bcgov/entity#35072.
package.json- hooks-only, just installs lefthook. Subfolders keep managing their own deps.lefthook.yml- secret scan only vianpx gitleaks-secret-scanner.gitleaks.toml- gitleaks default rules, lockfiles + this config allowlistedpnpm-workspace.yaml-allowBuilds: lefthook: false, so lefthook's own postinstall doesn't run (preparehandles the install). Without this, pnpm v11 fails the root install withERR_PNPM_IGNORED_BUILDS.document-service/documents-common/layers/base/pnpm-workspace.yaml- that layer has its own pnpm lockfile but no workspace file, so pnpm would pick up the new root one and silently install nothing there ("Already up to date"). Giving it its ownpackages: []keeps it standalone. Checked: installing in that folder gives identical results tomain(same 936 packages, same pre-existing ignored-builds output).documents-uialready has its own workspace file so it's unaffected.prepareisgit --version && lefthook install || exit 0, so it skips when there's no git (build images) and works on Windows too.To get the hook: run
pnpm installat the repo root once.Tested
Real
git commiton Windows, pnpm 11.9.0 with default build-script approval:pnpm installexits 0, hook installednotify-service/, indocument-service/→ blockedNo CI/CD workflow installs at the repo root (all path-scoped to service folders), so no pipeline impact.