klank v0.0.5

:hammer_and_wrench: Klank

Klank is a tool that will send notification to Pull Requests and Slack channel when a Pull Request is made. It will send the url of the CircleCI artifact.

This repository is inspired by expo-qr-notify by @watanabeyu

It can be used to send a link of latest storybook built in the Pull Request.

:package: Installation

yarn add -D klank

:book: Example

In order to user Klank, you will need to set up a CircleCI project.

In your Project Settings -> Environment Variables, enter your Circle CI API Token as CIRCLE_TOKEN, and Github API Token as GITHUB_TOKEN

In your config.yml for CircleCI, add commands to specify the path that contains the artifact you'd like to notify.

In your package.json, specify the file you'd like to notify

When you send a Pull Request, the account tied to your GITHUB_TOKEN will send a link of the artifact.

Slack Integration

Klank can also notify your CircleCI artifact to your slack channel!

Create an incoming webhook for your slack channel that you would like to notify.

Add the webhook URL as SLACK_WEBHOOK in your environment variables in CircleCI Project Settings.

:green_heart: Special Thanks

Special Thanks to @Leko for the original PR notification script.