Automate Github Pull Requests using Reactions
Project description
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
# Don't count any vote from a user who votes for multiple options
prevent_doubles: true
# 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: 30Voting
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 authYou 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 REPOSITORYClose
Close all pull requests that have passed the “timeout” date (if it is set).
gitconsensus close USERNAME REPOSITORYInfo
Get detailed infromation about a specific pull request and what rules it passes.
gitconsensus info USERNAME REPOSITORY PR_NUMBERForce Close
Close specific pull request, including any labels and comments that normally would be sent.
gitconsensus forceclose USERNAME REPOSITORY PR_NUMBERForce Merge
Merge specific pull request, including any labels and comments that normally would be sent.
gitconsensus forcemerge USERNAME REPOSITORY PR_NUMBERRelease history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for gitconsensus-0.3.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 544f292d517ce58a7642f2d1ce96e110a303ef54b60bb8f6eba9b95361135d7d |
|
| MD5 | 121040b5c75b947934652f6146976ecd |
|
| BLAKE2b-256 | 289f515361f224a6c4cf3cf859e7c70bd88f97d244cb5c8091e08d46bd7fa8af |
