https://github.com/shamin/detector
🤖: :rocket: A github bot to notify if there is any change in a set of files in a pull request.
https://github.com/shamin/detector
github-app javascript probot-app
Last synced: 7 months ago
JSON representation
🤖: :rocket: A github bot to notify if there is any change in a set of files in a pull request.
- Host: GitHub
- URL: https://github.com/shamin/detector
- Owner: shamin
- License: isc
- Created: 2018-10-15T14:43:13.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-10-27T16:52:05.000Z (almost 7 years ago)
- Last Synced: 2025-02-28T07:32:31.434Z (7 months ago)
- Topics: github-app, javascript, probot-app
- Language: JavaScript
- Homepage: https://github.com/apps/detector-app
- Size: 44.9 KB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Detector
A GitHub App built with 🤖Probot that helps to track changes to important files.
## Usage
- Install detector-io github app.
- Create a `.detector.yml` file with the file names that needs to be tracked in the following structure
```yml
absolute-paths: true
tracked-files:
- README.md
```
- Now detector app automatically checks and comments, if there is a change in the file tracked, in a pull request.
### Configuration file
| parameters | description | default |
| ------------- |-------------| ------------- |
| absolute-paths|If `true` will check for absolute paths of files in tracked-files.| false |
| tracked-files |Contains the list of files which need to be tracked for changes. | none |
## Setup
```sh
# Install dependencies
npm install
# Run the bot
npm start
```
## Contributing
If you have suggestions for how detector could be improved, or want to report a bug, open an issue! We'd love all and any contributions.
For more, check out the [Contributing Guide](CONTRIBUTING.md).
## License
[ISC](LICENSE) © 2018 Shamin Meerankutty