From e818f3c9333432be4276d85411bc4d67fb8b6c6b Mon Sep 17 00:00:00 2001 From: William B <7444334+whabanks@users.noreply.github.com> Date: Wed, 5 Feb 2025 10:06:04 -0400 Subject: [PATCH] Restore git blame usefulness (#351) - Added .git-blame-ignore-revs to the project - Exclude large formatting commits from git blame --- .devcontainer/scripts/notify-dev-entrypoint.sh | 3 +++ .git-blame-ignore-revs | 11 +++++++++++ 2 files changed, 14 insertions(+) create mode 100644 .git-blame-ignore-revs diff --git a/.devcontainer/scripts/notify-dev-entrypoint.sh b/.devcontainer/scripts/notify-dev-entrypoint.sh index 08781cbb..4a4840c7 100755 --- a/.devcontainer/scripts/notify-dev-entrypoint.sh +++ b/.devcontainer/scripts/notify-dev-entrypoint.sh @@ -22,6 +22,9 @@ poetry completions zsh > ~/.zfunc/_poetry # Install dependencies poetry install +# Set up git blame to ignore certain revisions e.g. sweeping code formatting changes. +git config blame.ignoreRevsFile .git-blame-ignore-revs + # Install pre-commit hooks git config --global --add safe.directory /workspaces/notification-utils poetry run pre-commit install \ No newline at end of file diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs new file mode 100644 index 00000000..06ee3799 --- /dev/null +++ b/.git-blame-ignore-revs @@ -0,0 +1,11 @@ +################################################################## +## This file lists commits that should be ignored by git blame. ## +## e.g. Formatting commits, non-functional changes, etc. ## +################################################################## + +# Black formatter https://github.com/cds-snc/notification-utils/commit/321dda7eb7ead83b32413f1b6425b78c757c2404 +321dda7eb7ead83b32413f1b6425b78c757c2404 +# Subsequent Black formatter changes https://github.com/cds-snc/notification-utils/commit/98dbf4c5234239e761375402a87a17ee07acc0d0 +98dbf4c5234239e761375402a87a17ee07acc0d0 +# Ruff formatter https://github.com/cds-snc/notification-utils/commit/56c2f9ff16038e1c6eb63979d5166e08110d3ec9 +56c2f9ff16038e1c6eb63979d5166e08110d3ec9