@hero-design/snowflake-guard
v1.2.3
Published
A hero-design bot detecting snowflake usage
Downloads
1,139
Readme
@hero-design/snowflake-guard
A GitHub App built with Probot that analyzes PR changes and reports snowflake usage of Hero Design components.
Setup
- Copy
.env.example
to.env
and asks Andromeda team for variable details.
cp .env.example .env
- Set up internal-tool-integrations service for the bot to store report.
- Replace
DB_HOST
with the host of the internal-tool-integrations service. - Use the same
SNOWFLAKE_GUARD_SECRET
as the one in the internal-tool-integrations service.
In case you don't want to store snowflake report, comment out the saving report
section in src/index.ts
.
Install snowflake-guard[Dev] app to a repository that you wish to run the app on.
Start
internal-tool-integrations
service.Start the bot.
# Install dependencies
yarn install
# Run the bot
yarn start
- Open or update a pull request to trigger webhook events.
Note
This bot does not support hot-reload yet, please restart the app once you make any changes to the code.