GHIA: GitHub Issue Assigner

Contents

• GHIA package
  • exports
  • ghia.cli module
  • ghia.github module
  • ghia.helpers module
  • ghia.web module
• Configuration
  • GitHub access
  • Assignment logic
• Usage
  • CLI
  • Webhook
• Testing
  • Unit tests
  • Integration tests
  • Module tests
  • Doctests
• Code examples
  • Checking for rule match
  • Processing single issues

• Repository: https://github.com/Dawnflash/ghia

• Documentation: https://ghia-zahumada.readthedocs.io/en/latest/

Introduction

GHIA is a Python package automating the process of GitHub issue assignment. The package lets you define your own rules for issue assignment and let GHIA handle the rest. It works both in batch mode as a script and in online mode as a Flask application.

Do I need this?

GitHub lacks a robust method for assigning people to issues based on custom logic. GHIA lets you define fine-grained regex matchers against issue parts, including labels. If you seek a way to automate issue assignment on GitHub, give GHIA a try.

Installation

GHIA requires Python 3.6.

You can install it from Test PyPI using pip

$ pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple ghia-zahumada

Alternatively you can clone the repository and run

$ pip install .

Assignment strategy

GHIA supports 3 assignment strategies:

• append: add matching users to existing assignees

• set: only process unassigned issues

• change: replace existing assignees with matching users

The default strategy is always append.

Building docs

Install the package with the dev extras. Docs are in the docs directory.

$ pip install .[dev]
$ cd docs
$ make html

License

GHIA is distributed under the MIT license, see LICENSE.