https://github.com/nylen/the-closer

Bot to automatically close new GitHub issues.
https://github.com/nylen/the-closer

bot github github-api github-bot issues

Last synced: about 1 month ago
JSON representation

Bot to automatically close new GitHub issues.

• Host: GitHub
• URL: https://github.com/nylen/the-closer
• Owner: nylen
• Created: 2017-01-05T22:23:51.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2017-01-06T01:33:58.000Z (about 8 years ago)
• Last Synced: 2024-10-30T21:42:42.647Z (3 months ago)
• Topics: bot, github, github-api, github-bot, issues
• Language: JavaScript
• Size: 3.91 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# The Closer

This is a bot that automatically closes GitHub issues.  You can specify a

minimum issue number if you want to leave older issues open.

Also, the bot will write the issues it closes to a JSON file so that you can

re-open them without further interference.

## Installation

First, make sure you have Node.js installed (tested on version 5.12.0).

Then:

```

git clone https://github.com/nylen/the-closer.git

cd the-closer

npm install

cp sample-config.json config.json

```

Then fill in the values in `config.json`.

## Configuration

- `username`: Your GitHub username.

- `apiToken`: Your [GitHub API token](https://github.com/settings/tokens).

- `owner`: The owner of the repository where you want to close issues.

- `repo`: The name of the repository where you want to close issues.

- _(optional)_ `firstIssueNumber`: Close issues with this issue number or higher.

For the message to use when closing an issue, the plugin will read a file

called `MESSAGE.md` in the same directory as the config file.

## Usage

```sh

node bin/the-closer.js

```

I recommend setting this to run using a cron job, e.g. every 5 minutes.