status-im/status-github-bot
2
0
Fork 0
mirror of https://github.com/status-im/status-github-bot.git synced 2025-02-27 20:30:37 +00:00
Code Issues Projects Releases Wiki Activity

document setup of .env file

Browse Source
This commit is contained in:
Martin Klepsch 2018-02-05 14:01:12 +01:00 committed by Pedro Pombeiro
parent f12d722bc7
commit 3164cd8d9b
No known key found for this signature in database
GPG Key ID: A65DEB11E4BBC647
2 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
.env.example
View File

@ -12,4 +12,8 @@ WEBHOOK_PROXY_URL=https://smee.io/ZyQCjZTDPT3pd4SD
SLACK_BOT_TOKEN=
# A "User Legacy Token" of your Slack App, used to access the "users.profile.get" API
SLACK_USER_TOKEN=
SLACK_USER_TOKEN=
# Bot configuration (optional)
#
# DRY_RUN_BOUNTY_APPROVAL=true

17
README.md
View File

@ -25,6 +25,23 @@ Right now the bot has two sets of capabilities:
The project board names, column names, welcome message and other values are stored in the `.github/github-bot.yml` file. It can be overriden for each specific repository by adding a file in the same path on the respective repository (see [probot-config](https://github.com/getsentry/probot-config)).
## Development
To get your environment set up go through the following steps:
1. Run `npm install`
2. Populate `.env`
```sh
cp .env.example .env
# edit .env file to contain proper config
```
After this you can start the bot by running:
```sh
npm start
```
## Creating the bot GitHub App
This bot is meant to be packaged as a GitHub App. There are two steps to it: creating the app, and installing the app. Creating a GitHub App only needs to be done once and the app can be made public to be reused for any number of repositories and organizations.