🔧 Repository: backstage/community-plugins

[bplaxco]

📜 Description

Hey folks 👋

I'm filing an issue here to see if we can make a small change to the .husky/pre-commit script in this repository to allow it to optionally support git hooks that were copied in from the git init template dir.

It'd be a three line addition at the end of the file and I don't expect it should cause issues for existing contributors. Or at least that's the hope that it can be added in a non-impactful way.

Here's the snippet that'd go at the very end of .husky/pre-commit:

# support local pre-commit hooks
if [ -x .git/hooks/pre-commit ]; then
  exec .git/hooks/pre-commit
fi

👍 Expected behavior

It would be desirable to also run a pre-commit hook located at .git/hooks/pre-commit after running the other hooks defined in the script, but only if .git/hooks/pre-commit exists and is executable.

👎 Current Behavior

It currently just runs the husky hooks (which is not a flaw, just not desirable for one of our use cases).

👟 Reproduction steps

1. Add a custom pre-commit hook in .git/hooks/pre-commit
2. Set up the repo for normal contrib (i.e. in the way that sets up husky)
3. See that git ignores the default location for the hook and favors the husky hook instead

📃 Provide the context for the Bug.

The main reason for the change is we use a pre-commit hook to detect leaks during commits. This would provide a way for that process to continue and be transparent to the work in the repo here. And also if folks have other pre-commit hooks they want to use locally but not make it an official part of backstage's repos, it'd be supported as well 👍

👀 Have you spent some time to check if this bug has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

Are you willing to submit PR?

Yes I am willing to submit a PR!

[bplaxco]

cc: @kim-tsao

[vinzscam]

what exactly do you want to run on your pre-commit hook? Is this something you are proposing we should enforce on community plugins?

[bplaxco]

I want to run a secret scanner in my pre-commit hook. No, it would not be enforced on community plugins. The content of the pre-commit hook will not be checked into the repo.

The suggested implementation is hook agnostic and should be transparent to existing users. It only additionally re-enables git's default behavior for running a pre-commit hook. So instead of husky replacing the default behavior with its hooks, it runs its hooks + enables the default pre-commit hook behavior in git. 👌

[awanlin]

@bplaxco, submit a PR for this and we'll give it a try 👍

[bplaxco]

Cool cool. I'll aim to do that Fri or early next week 🫡