Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/patrickhulce/git3po

Automatically comments, labels, and closes GitHub issues according to a configurable set of filters.
https://github.com/patrickhulce/git3po

comment-bot github-bot github-issues

Last synced: 17 days ago
JSON representation

Automatically comments, labels, and closes GitHub issues according to a configurable set of filters.

Host: GitHub
URL: https://github.com/patrickhulce/git3po
Owner: patrickhulce
License: mit
Created: 2017-07-29T19:45:58.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2023-03-15T08:42:40.000Z (over 1 year ago)
Last Synced: 2024-10-19T00:51:07.032Z (25 days ago)
Topics: comment-bot, github-bot, github-issues
Language: JavaScript
Homepage:
Size: 2.92 MB
Stars: 37
Watchers: 6
Forks: 7
Open Issues: 16
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # git3po

[![NPM Package](https://badge.fury.io/js/git3po.svg)](https://www.npmjs.com/package/git3po)

[![Build Status](https://travis-ci.org/patrickhulce/git3po.svg?branch=master)](https://travis-ci.org/patrickhulce/git3po)

[![Coverage Status](https://coveralls.io/repos/github/patrickhulce/git3po/badge.svg?branch=master)](https://coveralls.io/github/patrickhulce/git3po?branch=master)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

[![Dependencies](https://david-dm.org/patrickhulce/git3po.svg)](https://david-dm.org/patrickhulce/git3po)

Automatically comments, labels, and closes GitHub issues and pull requests according to a configurable set of filters.

## Usage

### Install

`npm install -g git3po`

### Configure

```yaml

token:   # alternatively set via the `GIT3PO_GH_TOKEN` env variable.

repo: patrickhulce/git3po

startAt: 2017-07-01

filters:

  - type: issue

    criteria:

      state: open # open issues

      text:

        $match: test phrase # with title or body containing 'test phrase'

      author:

        $not:

          $in: [janesmith, johndoe] # whose author is not janesmith or johndoe

actions:

  - type: add_comment

    body: >

      Hello from the bots

      I'm an awesome multi-line comment

  - type: add_label

    label: duplicate

  - type: close

```

See also

* [`examples/unable-to-load-page.yaml`](./examples/unable-to-load-page.yaml)

* [`examples/apply-waiting4reviewer.yaml`](./examples/apply-waiting4reviewer.yaml)

* [Many real scripts used by Lighthouse](https://github.com/GoogleChrome/lighthouse/tree/master/lighthouse-core/scripts/git3po-rules)

### Use

```sh

git3po -c config.yaml

💎  Found #1 (test phrase), processing...

     Applying add comment...             ⏳

     Applying add label...               ⏳

     Applying close...                   ⏳

✅  Done with #1

```