guardian / bucket-blocker

MIT License
0 stars 0 forks source link

ci: enforce the use of a dash between bucket and blocker #17

Closed NovemberTang closed 1 week ago

NovemberTang commented 1 week ago

What does this change?

Enforces the spelling of bucket-blocker, for consistency. Previously this has cause issues such as the brew formula being called bucket-blocker, but the program being executed using bucketblocker, which is a very odd user experience. Potentially this could be set up as a pre-commit hook, but that requires the user to (at a minimum) follow some setup instructions, which is not guaranteed to happen. A hook could also be set up using the same script as a later date.

The -i flag in grep indicates that matches should disregard case, so we will catch other varieties such as BucketBlocker, bucketBlocker, BUCKETBLOCKER, etc.

How to test

CI should fail when it runs on a bad commit (see the action run on the first commit)

How can we measure success?

This doesn't happen again