https://github.com/offu/close-issue-app

A github app to close issue
https://github.com/offu/close-issue-app

github-app issue-bot probot probot-app

Last synced: about 1 month ago
JSON representation

A github app to close issue

• Host: GitHub
• URL: https://github.com/offu/close-issue-app
• Owner: offu
• License: agpl-3.0
• Created: 2018-05-28T00:59:31.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-03-20T20:43:43.000Z (8 months ago)
• Last Synced: 2024-03-27T00:12:12.487Z (8 months ago)
• Topics: github-app, issue-bot, probot, probot-app
• Language: TypeScript
• Homepage: https://github.com/apps/close-issue-app
• Size: 2.12 MB
• Stars: 37
• Watchers: 4
• Forks: 3
• Open Issues: 33
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Close Issue App

[![Build Status](https://github.com/offu/close-issue-app/workflows/Run%20tests/badge.svg)](https://github.com/offu/close-issue-app/actions)

[![codecov](https://codecov.io/gh/offu/close-issue-app/branch/master/graph/badge.svg)](https://codecov.io/gh/offu/close-issue-app)  

An app to close issues.

### What It Does

The app will check new opened and reopened issues if they include some specific contents. Issues not passed will be commented then closed.

### Usage

1. Create a `.github/issue-close-app.yml` file in your repo. Here's an example:  

``` yaml

# Comment that will be sent if an issue is judged to be closed.

comment: "This issue is closed because it does not meet our issue template. Please read it."

issueConfigs:

# There can be several configs for different kind of issues.

- content:

# Example 1: bug report

  - "Expected Behavior"

  - "Current Behavior"

  - "Steps to Reproduce"

  - "Detailed Description"

- content:

# Example 2: feature request

  - "Motivation / Use Case"

  - "Expected Behavior"

  - "Other Information"

# Optional configuration:

#

# whether the keywords are case-insensitive

# default value is false, which means keywords are case-sensitive

caseInsensitive: false

# the label that will be added when the bot close an issue

# The bot will only add a label if this property is set.

label: "closed by bot"

# The bot will ignore any issues that are opened or reopened by the user names in exception

exception:

  - "username1"

  - "username2"

# The issue is judged to be legal if it includes all keywords from any of these two configs.

# Or it will be closed by the app.

```

The config file is **required** to run this app. If the app can not find a valid config file, it will ignore requests from the repo.  

2. Install the [close-issue-app](https://github.com/apps/close-issue-app).  

3. Enjoy!

### Deployment

Read [probot docs](https://probot.github.io/docs/deployment/).