Files
probot.github.io/_apps/reaction.md
Brandon Keepers 2a52d7a4e7 Sync data
2019-01-13 22:04:19 +00:00

81 lines
2.2 KiB
Markdown

---
title: Reaction Comments
description: Deletes +1 comments and encourages the use of GitHub reactions.
slug: reaction
screenshots:
- https://raw.githubusercontent.com/dessant/reaction-comments/master/assets/screenshot.png
authors:
- dessant
repository: dessant/reaction-comments
host: https://probot-reaction-comments.glitch.me
stars: 15
updated: 2018-10-03 03:16:23 UTC
installations: 56
organizations:
- zealdocs
- invertase
- Mottie
- CellularPrivacy
- Radarr
- sethvargo
- idehub
- chefspec
- nextcloud
- buschtoens
---
A GitHub App that deletes reaction comments, such as +1,
and encourages the use of GitHub reactions.
## How It Works
The app detects if a new comment consists solely of emojis and shortcodes
used in GitHub reactions. A matching comment is either replaced
with the message set in `reactionComment` and deleted after a day,
or it is deleted immediately, if `reactionComment` is set to `false`.
## Usage
1. **[Install the GitHub App](https://github.com/apps/reaction)**
for the intended repositories
2. Create `.github/reaction.yml` based on the template below
#### Configuration
Create `.github/reaction.yml` in the default branch to enable the app.
The file can be empty, or it can override any of these default settings:
```yaml
# Configuration for reaction-comments - https://github.com/dessant/reaction-comments
# Issues and pull requests with these labels accept reaction comments.
# Set to `[]` to disable
exemptLabels: []
# Replace matching comments with this message, `{comment-author}` is an
# optional placeholder. Set to `false` to disable
reactionComment: >
:wave: @{comment-author}, did you mean to use
a [reaction](https://git.io/vhzhC) instead?
# Limit to only `issues` or `pulls`
# only: issues
# Optionally, specify configuration settings just for `issues` or `pulls`
# issues:
# exemptLabels:
# - party-parrot
# pulls:
# reactionComment: false
# Repository to extend settings from
# _extends: repo
```
## Supporting the Project
The continued development of Reaction Comments is made possible
thanks to the support of awesome backers. If you'd like to join them,
please consider contributing with [Patreon](https://www.patreon.com/dessant).