gitconsensus

This simple project allows github projects to be automated. It uses “reaction” as a voting mechanism to automatically merge (or close) pull requests.

Consensus Rules

The file .gitconsensus.yaml needs to be placed in the repository to be managed. Any rule set to false or ommitted will be skipped.

# Add extra labels for the vote counts and age when merging
extra_labels: false

# Minimum number of voters
quorum: 5

# Required percentage of "yes" votes (ignoring abstentions)
threshold: 0.65

# Only process votes by contributors
contributors_only: false

# Only process votes by collaborators
collaborators_only: false

# When defined only process votes from these github users
whitelist:
  - alice
  - bob
  - carol

# Number of days after last action (commit or opening the pull request) before issue can be merged
mergedelay: 3

# Number of days after last action (commit or opening the pull request) before issue is autoclosed
timeout: 30

Voting

Votes are made by using reactions on the top level comment of the Pull Request.

Reaction	Vote
	Yes
	No
	Abstain

Label Overrides

Any Pull Request with a WIP or DONTMERGE label (case insensitive) will be skipped over.

Commands

Authentication

gitconsensus auth

You will be asked for your username, password, and 2fa token (if configured). This will be used to get an authentication token from Github that will be used in place of your username and password (which are never saved).

Merge

Merge all pull requests that meet consensus rules.

gitconsensus merge USERNAME REPOSITORY

Close

Close all pull requests that have passed the “timeout” date (if it is set).

gitconsensus close USERNAME REPOSITORY

Info

Get detailed infromation about a specific pull request and what rules it passes.

gitconsensus info USERNAME REPOSITORY PR_NUMBER

Force Close

Close specific pull request, including any labels and comments that normally would be sent.

gitconsensus forceclose USERNAME REPOSITORY PR_NUMBER

Force Merge

Merge specific pull request, including any labels and comments that normally would be sent.

gitconsensus forcemerge USERNAME REPOSITORY PR_NUMBER

Development Status
- 4 - Beta
Environment
- Console
Intended Audience
- Developers
- System Administrators
License
- OSI Approved :: MIT License
Programming Language
- Python :: 3
Topic
- Software Development :: Version Control

Metadata

Development Status
- 4 - Beta
Environment
- Console
Intended Audience
- Developers
- System Administrators
License
- OSI Approved :: MIT License
Programming Language
- Python :: 3
Topic
- Software Development :: Version Control

Release files for gitconsensus 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for gitconsensus 0.2.0
File	Interpreter	ABI	Platform	Reset
gitconsensus-0.2.0-py3-none-any.whl 9.2 kB Aug 23, 2017	Python 3	none	any	Details

Release files / gitconsensus-0.2.0-py3-none-any.whl

Download URL	gitconsensus-0.2.0-py3-none-any.whl
Size	9.2 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`03ad1e4e46e153e15fe2c63306a37f935af3a5a466e1d6684ba225e26dcd374b`
BLAKE2b-256 checksum How to use checksums	`beefb09a8ff6d727d4a051a95550a2fb0e4ff46f6cc2acab9d969ccca81828ab`
Upload date	Aug 23, 2017
Uploaded using Trusted Publishing? What is trusted publishing?	No