mirror of
https://github.com/zhigang1992/probot.github.io.git
synced 2026-01-12 22:49:53 +08:00
Add Reaction Comments app
This commit is contained in:
64
_apps/reaction.md
Normal file
64
_apps/reaction.md
Normal file
@@ -0,0 +1,64 @@
|
||||
---
|
||||
title: Reaction Comments
|
||||
description: Deletes +1 comments and educates users about 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
|
||||
---
|
||||
|
||||
A GitHub App that educates users about the correct use of GitHub reactions,
|
||||
and deletes new reaction comments, such as +1.
|
||||
|
||||
## 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)**
|
||||
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, `{user}` is a placeholder
|
||||
# for the comment author. Set to `false` to disable
|
||||
reactionComment: >
|
||||
:wave: @{user}, 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).
|
||||
Reference in New Issue
Block a user