Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/boyney123/auto-comment

A GitHub App built with Probot that automatically comments on issues and pull requests based on configuration
https://github.com/boyney123/auto-comment

comment github-app github-bot probot

Last synced: 4 months ago
JSON representation

A GitHub App built with Probot that automatically comments on issues and pull requests based on configuration

Host: GitHub
URL: https://github.com/boyney123/auto-comment
Owner: boyney123
License: mit
Created: 2018-07-05T16:19:27.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2019-09-26T14:00:33.000Z (over 5 years ago)
Last Synced: 2024-09-27T08:02:26.067Z (4 months ago)
Topics: comment, github-app, github-bot, probot
Language: JavaScript
Homepage: https://github.com/marketplace/auto-comment
Size: 54.7 KB
Stars: 26
Watchers: 4
Forks: 17
Open Issues: 5
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


  

  
auto-comment

  A GitHub App built with Probot that comments on new issues and pull requests based on your configuration.


  


    

    

 

  


![todo](./example.png)

## Usage

Using **auto-comment** is simple. Once you've installed it in your repository you will need to setup your `.github/auto-comment.yml` file and **auto-comment** will do the rest.

## Configuring for your project

There are a couple of configuration options that you will need to setup depending on what you want.

```yml

# Comment to a new issue.

issuesOpened: >

  Thank you for raising an issue. We will try and get back to you as soon as possible.

  Please make sure you have given us as much context as possible.

pullRequestOpened: >

  Thank you for raising your pull request.

  Please make sure you have followed our contributing guidelines. We will review it as soon as possible.

```

### Available options for Issues

| Name               | Description                                    |

| ------------------ | ---------------------------------------------- |

| issuesOpened       | Message when issues are created.               |

| issuesClosed       | Message when be shown when the issue is closed |

| issuesLabeled      | Message when issues are labeled                |

| issuesUnlabeled    | Message when issues are unlabeled              |

| issuesEdited       | Message when issues are edited                 |

| issuesMilestoned   | Message when issues have been milestoned       |

| issuesDemilestoned | Message when issues have been demilestoned     |

| issuesClosed       | Message when issues are closed                 |

| issuesReopened     | Message when issues are reopened               |

| issuesAssigned     | Message when issues are assigned               |

| issuesUnassigned   | Message when issues are unassigned             |

### Available options for Pull Requests

| Name                            | Description                                                    |

| ------------------------------- | -------------------------------------------------------------- |

| pullRequestOpened               | Message when pull requests are opened .                        |

| pullRequestClosed               | Message when be shown when the issue is closed                 |

| pullRequestReviewRequested      | Message when be shown when a reviewer has been requested       |

| pullRequestReviewRequestRemoved | Message when be shown when a reviewer request has been removed |

| pullRequestLabeled              | Message when pullRequest are labeled                           |

| pullRequestUnlabeled            | Message when pullRequest are unlabeled                         |

| pullRequestEdited               | Message when pullRequest are edited                            |

| pullRequestClosed               | Message when pullRequest are closed                            |

| pullRequestReopened             | Message when pullRequest are reopened                          |

| pullRequestAssigned            | Message when pullRequests are assigned                         |

| pullRequestUnassigned          | Message when pullRequests are unassigned                       |