From a11835feafc7778c650beee4013dd502e546c809 Mon Sep 17 00:00:00 2001 From: Yuyang Zhang Date: Fri, 8 Jun 2018 18:33:40 +0800 Subject: [PATCH 1/3] create close-issue.md --- _apps/close-issue.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 _apps/close-issue.md diff --git a/_apps/close-issue.md b/_apps/close-issue.md new file mode 100644 index 0000000..33a6abd --- /dev/null +++ b/_apps/close-issue.md @@ -0,0 +1,30 @@ +--- +title: Close Issue +description: Comment on the issues that do not include some contents then close them. +slug: close-issue-bot +screenshots: +- https://raw.githubusercontent.com/offu/close-issue-bot/master/screenshot.png +authors: [ helloqiu, whtsky ] +repository: offu/close-issue-bot +host: https://damp-citadel-91689.herokuapp.com +--- +[![Build Status](https://travis-ci.org/offu/close-issue-bot.svg?branch=master)](https://travis-ci.org/offu/close-issue-bot) +[![codecov](https://codecov.io/gh/offu/close-issue-bot/branch/master/graph/badge.svg)](https://codecov.io/gh/offu/close-issue-bot) +## What It Does +The bot 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-bot.yml``` file in your repo. Here's an example: +``` yaml +# Comment that will be sent if an issue is judged to be closed +comment: test +# You can have several configs for different issues. +issueConfigs: +- content: + - content1 + - content2 + - "🐶" +- content: + - "🐱" +``` +2. Install the [close-issue-bot](https://github.com/apps/close-issue-bot). +3. Enjoy! \ No newline at end of file From 6f2e9da2422d4812f1213df871642f47ae60da75 Mon Sep 17 00:00:00 2001 From: Yuyang Zhang Date: Thu, 21 Jun 2018 21:21:14 +0800 Subject: [PATCH 2/3] change 'bot' to 'app' --- _apps/close-issue.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/_apps/close-issue.md b/_apps/close-issue.md index 33a6abd..9e46228 100644 --- a/_apps/close-issue.md +++ b/_apps/close-issue.md @@ -1,17 +1,17 @@ --- title: Close Issue description: Comment on the issues that do not include some contents then close them. -slug: close-issue-bot +slug: close-issue-app screenshots: -- https://raw.githubusercontent.com/offu/close-issue-bot/master/screenshot.png +- https://raw.githubusercontent.com/offu/close-issue-app/master/screenshot.png authors: [ helloqiu, whtsky ] -repository: offu/close-issue-bot +repository: offu/close-issue-app host: https://damp-citadel-91689.herokuapp.com --- -[![Build Status](https://travis-ci.org/offu/close-issue-bot.svg?branch=master)](https://travis-ci.org/offu/close-issue-bot) -[![codecov](https://codecov.io/gh/offu/close-issue-bot/branch/master/graph/badge.svg)](https://codecov.io/gh/offu/close-issue-bot) +[![Build Status](https://travis-ci.org/offu/close-issue-app.svg?branch=master)](https://travis-ci.org/offu/close-issue-app) +[![codecov](https://codecov.io/gh/offu/close-issue-app/branch/master/graph/badge.svg)](https://codecov.io/gh/offu/close-issue-app) ## What It Does -The bot will check new opened and reopened issues if they include some specific contents. Issues not passed will be commented then closed. +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-bot.yml``` file in your repo. Here's an example: ``` yaml @@ -26,5 +26,5 @@ issueConfigs: - content: - "🐱" ``` -2. Install the [close-issue-bot](https://github.com/apps/close-issue-bot). +2. Install the [close-issue-app](https://github.com/apps/close-issue-app). 3. Enjoy! \ No newline at end of file From 8221724d50d23200f27348df1751b42c2a545716 Mon Sep 17 00:00:00 2001 From: Yuyang Zhang Date: Thu, 21 Jun 2018 22:05:07 +0800 Subject: [PATCH 3/3] update some info and flesh out exmaples --- _apps/close-issue.md | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/_apps/close-issue.md b/_apps/close-issue.md index 9e46228..9f410f4 100644 --- a/_apps/close-issue.md +++ b/_apps/close-issue.md @@ -6,25 +6,33 @@ screenshots: - https://raw.githubusercontent.com/offu/close-issue-app/master/screenshot.png authors: [ helloqiu, whtsky ] repository: offu/close-issue-app -host: https://damp-citadel-91689.herokuapp.com +host: https://close-issue-app.herokuapp.com --- [![Build Status](https://travis-ci.org/offu/close-issue-app.svg?branch=master)](https://travis-ci.org/offu/close-issue-app) [![codecov](https://codecov.io/gh/offu/close-issue-app/branch/master/graph/badge.svg)](https://codecov.io/gh/offu/close-issue-app) ## 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-bot.yml``` file in your repo. Here's an example: +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: test -# You can have several configs for different issues. +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: - - content1 - - content2 - - "🐶" +# 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" +# 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. And there is no **default config**. 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! \ No newline at end of file