Add reusable workflow to check that email used in history is @*.gc.ca

[rngadam]

There are, for example, personal emails (such as @gmail.com) emails in the commit history of this repo.

We want to enforce the professional email to be used by employees when committing to ai-cfia while allowing external contributors.

TODO

• update environment setup documentation to ensure developers properly set their development environment and github account for web editing
• Add reusable workflow to check that email used in history is @inspection.gc.ca (or from a whitelisted set of users) and fails the pull request if new commits are without the professional address.

more information

Setting a corporate email per organization has been a long standing feature request:

https://github.com/todogroup/gh-issues/issues/32

[SonOfLope]

@rngadam Do we want the user to create a new pull request with appropriate commits ? or should we not go with pre commit hooks that validates user email prior to applying a commit ? something like https://gist.github.com/hartfordfive/20b2245ab1f04aca4ecad28416919ffc

[rngadam]

I generally prefer either validation in the IDE or in our Github Workflow instead of git precommit hooks. Since we hooked in "repo standards" validation I would start there.

Introducing an additional mechanism will add steps to setting up repos on top of those.

Also note that someone could want to fork our repositories and would be stuck disabling precommit hooks that don't apply to him.

rule should be to accept any .gc.ca and warn on any other email with a message in the PR (in some cases, we may accept external contributors emails so it's not an hard no).