Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lswith/probot-add-comment
A bot to add a comment to issues/PRs on github when a specific label is present
https://github.com/lswith/probot-add-comment
probot probot-app
Last synced: 1 day ago
JSON representation
A bot to add a comment to issues/PRs on github when a specific label is present
- Host: GitHub
- URL: https://github.com/lswith/probot-add-comment
- Owner: lswith
- License: apache-2.0
- Created: 2019-07-09T00:03:33.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T02:01:36.000Z (about 2 years ago)
- Last Synced: 2024-12-15T11:07:50.580Z (26 days ago)
- Topics: probot, probot-app
- Language: TypeScript
- Size: 3.39 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Add Comment Bot
[![Downloads][npm-downloads]][npm-url] [![version][npm-version]][npm-url]
[![Build Status][travis-status]][travis-url]
A [Probot](https://probot.github.io) bot to add/remove a comment to issues and pull requests when a label is present/removed.
## Setup
Add a `.github/comment.yml` file to your repository and then run the bot against it.
If the config is empty or doesn't exist, the bot will not run.
```yml
# Example Config
# This config will look for any issues and pull requests that have been labeled with `needs-area`. A comment
# will be added to the issue or pull request and will be removed once the `needs-area` label is removed.
issues:
- label: needs-area
comment: |
Please add an `area:` label to this issue.
pulls:
- label: needs-area
comment: |
Please add an `area:` label to this pull request.
```
### Backwards compatibility
Previous version of the bot will still work with current version, as the schema for the configuration file does not change the structure. So it's possible to upgrade and keep old configuration:
```yaml
# The old format matches the new one, using a different name
comments:
- label: needs-area
comment: |
Please add an `area:` label to this issue.
```
## Contribute
If you have suggestions for how this bot could be improved, or want to report a bug, open an issue! We'd love all and any contributions.
[travis-status]: https://travis-ci.org/lswith/probot-add-comment.svg?branch=master
[travis-url]: https://travis-ci.org/lswith/probot-add-comment
[npm-downloads]: https://img.shields.io/npm/dm/probot-add-comment.svg?style=flat
[npm-version]: https://img.shields.io/npm/v/probot-add-comment.svg?style=flat
[npm-url]: https://www.npmjs.com/package/probot-add-comment