Skip to content

Document the startup procedure #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 7, 2016
Merged

Document the startup procedure #7

merged 1 commit into from
Apr 7, 2016

Conversation

phillipj
Copy link
Member

@phillipj phillipj commented Apr 4, 2016

This documents the most basic "setup" needed to get the bot up and running.

@phillipj
Copy link
Member Author

phillipj commented Apr 4, 2016

Hm... Just realized the current procedure of polling the Travis API for build status also needs its own token.

@williamkapke
Copy link
Contributor

I think ultimately this bot will need many tokens for many services. I'm using a .env file and https://www.npmjs.com/package/dotenv to load it.

@phillipj
Copy link
Member Author

phillipj commented Apr 4, 2016

dotenv is nice. Should we still document which tokens are required and how to generate them in the readme?

@williamkapke
Copy link
Contributor

I think an example .env file in the readme would do the trick:

WEBHOOK_SECRET="hush-hush"
GITHUB_TOKEN="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
TRAVIS_CI_TOKEN="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

I make use of the silent: true option so if there isn't an .env file- it doesn't do anything.

require('dotenv').load({ silent: true, path: __dirname + '/.env' })

Also, Make sure to add .env to the .gitignore so there are no accidental commits ;).

@williamkapke williamkapke mentioned this pull request Apr 6, 2016
MIT

This comment was marked as off-topic.

This comment was marked as off-topic.

@Fishrock123
Copy link
Contributor

seems good to me

@phillipj phillipj force-pushed the document-start-proc branch from e9a8114 to 9ee52a4 Compare April 7, 2016 18:58
@phillipj
Copy link
Member Author

phillipj commented Apr 7, 2016

@williamkapke as you introduce dotenv in #8, I'll skip any of that in this PR

@phillipj phillipj merged commit 96d47ee into master Apr 7, 2016
@phillipj phillipj deleted the document-start-proc branch April 7, 2016 19:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants