Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/dessant/support-requests-app

GitHub App that comments on and closes issues labeled as support requests
https://github.com/dessant/support-requests-app

github-app issues probot probot-app support

Last synced: 3 months ago
JSON representation

GitHub App that comments on and closes issues labeled as support requests

Awesome Lists containing this project

README

        

# Support Requests

[![Version](https://img.shields.io/npm/v/support-requests.svg?colorB=007EC6)](https://www.npmjs.com/package/support-requests)

> This project is no longer maintained, please migrate to [Support Requests](https://github.com/dessant/support-requests).

Support Requests is a GitHub App built with [Probot](https://github.com/probot/probot)
that comments on and closes issues labeled as support requests.

![](assets/screenshot.png)

## Usage

1. **[Install the GitHub App]()**
for the intended repositories
2. Create `.github/support.yml` based on the template below
3. Start labeling issues as support requests

**If possible, install the app only for select repositories.
Do not leave the `All repositories` option selected, unless you intend
to use the app for all current and future repositories.**

#### Configuration

Create `.github/support.yml` in the default branch to enable the app,
or add it at the same file path to a repository named `.github`.
The file can be empty, or it can override any of these default settings:

```yaml
# Configuration for Support Requests - https://github.com/dessant/support-requests-app

# Label used to mark issues as support requests
supportLabel: support

# Comment to post on issues marked as support requests, `{issue-author}` is an
# optional placeholder. Set to `false` to disable
supportComment: >
:wave: @{issue-author}, we use the issue tracker exclusively for bug reports
and feature requests. However, this issue appears to be a support request.
Please use our support channels to get help with the project.

# Close issues marked as support requests
close: true

# Lock issues marked as support requests
lock: false

# Assign `off-topic` as the reason for locking. Set to `false` to disable
setLockReason: true

# Repository to extend settings from
# _extends: repo
```

## Deployment

See [docs/deploy.md](docs/deploy.md) if you would like to run your own
instance of this app.

## License

Copyright (c) 2017-2021 Armin Sebastian

This software is released under the terms of the MIT License.
See the [LICENSE](LICENSE) file for further information.