Skip to main content

CLI support tool for GitHub repo maintainers

Project description

PyPI Downloads Latest PyPI version License

Command line tool to help you in the role of an Open Source project maintainer on GitHub.

  • Reads MAINTAINERS file to find repositories you are responsible for
  • Allows listing open issues and pull requests

Why?

One could argue that the GitHub “watch” feature (+ notifications) should be enough to get along, but what if I want to watch many repositories but only maintain a few?

GitHub has no notion of a “project maintainer”, therefore we use the convention of putting a MAINTAINERS file in the root of each git repository.

Each person listed in the MAINTAINERS file is responsible for managing issues, pull requests and keeping code quality.

This tool should support you as a maintainer in doing so easily from the command line.

Usage

$ sudo pip3 install -U github-maintainer
$ github-maintainer configure      # initial setup
$ github-maintainer repositories   # list my repos
$ github-maintainer issues         # list my issues
$ github-maintainer pull-requests  # list my PRs
$ github-maintainer patch 'myorg/.*' Dockerfile 'openjdk:8.*' openjdk:8-123  # replace patterns

Running Unit Tests

$ python3 setup.py test --cov-html=true

Releasing

$ ./release.sh <NEW-VERSION>

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for github-maintainer, version 0.1.8
Filename, size File type Python version Upload date Hashes
Filename, size github_maintainer-0.1.8-py3-none-any.whl (8.2 kB) File type Wheel Python version 3.5 Upload date Hashes View
Filename, size github-maintainer-0.1.8.tar.gz (7.0 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page