https://github.com/tabuckner/cucumberjs-slack-bot
https://github.com/tabuckner/cucumberjs-slack-bot
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/tabuckner/cucumberjs-slack-bot
- Owner: tabuckner
- Created: 2018-01-24T16:19:10.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-04-18T13:33:16.000Z (about 8 years ago)
- Last Synced: 2025-02-16T15:24:28.313Z (over 1 year ago)
- Language: JavaScript
- Size: 3.91 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Protractor/Cucumber Slack Notification Tool
Simple JSON parser and slack notification bot. Designed to be used with a Slack Web API endpoint.
## Getting Started
Designed to be used as a dev dependency. Explore your options if you'd like.
```
npm install --save-dev cucumberjs-slack-bot
```
### Prerequisites
Designed for a specific use-case. If you are using Protractor with CucumberJS _and_ Slack, you might find this tool useful.
This tool requires a Slack Web API endpoint. [Read More](https://api.slack.com/web)
### Installing
To use simply require the module:
```
const slackBot = require('./bot');
```
Define your Slackbot configuratoin options:
```
const slackBotOptions = {
githubAccount: '[your account name: string]',
githubRepo: '[your repo name: string]',
cucumberJSON: '[filepath of Protractor JSON output: string]',
slackEndpoint: 'https://hooks.slack.com/services/your/endpoint'
}
```
Then call the function:
```
slackBot.newSlackNotification(slackBotOptions);
```
## Built With
* [git-repo-info](https://www.npmjs.com/package/git-repo-info) - For git info
* [request](https://www.npmjs.com/package/request) - For hitting endpoint
* [request-promise](https://www.npmjs.com/package/request-promise) - Cause promises
## Contributing
Submit a PR on the github repo
## Authors
* **Taylor Buckner** - *WIP* - [tabuckner](https://github.com/tabuckner)
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details