gitconsensus 0.8.0
Automate Github Pull Requests using Reactions
Requires Python: >=3
Keywords: automation github consensus git

# 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.

You can run `gitconsensus init` to start with a template configuration in the current working directory.

```yaml
# Which version of the consensus rules to use
version: 3

# 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

# The following only applies to pull requests
pull_requests:

  # 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
    - carol

  # When defined votes from these users will be ignored
  blacklist:
    - bob
    - dan

  # Number of hours after last action (commit or opening the pull request) before issue can be merged
  merge_delay: 24

  # Number of votes from contributors at which the mergedelay gets ignored, assuming no negative votes.
  delay_override: 10

  # When `delayoverride` is set this value is the minimum hours without changes before the PR will be merged
  merge_delay_min: 1

  # Require this amount of time in hours before a PR with a license change will be merged.
  licensed_delay: 72

  # Require this amount of time in hours before a PR with a consensus change will be merged.
  consensus_delay: 72

  # Do not allow license changes to be merged.
  license_lock: true

  # Do not allow consensus changes to be merged.
  consensus_lock: true

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

## Voting

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

| Reaction | Vote    |
|----------|---------|
| ![+1](https://github.githubassets.com/images/icons/emoji/unicode/1f44d.png "+1")       | Yes     |
| ![-1](https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png "-1")       | No      |
| ![confused](https://github.githubassets.com/images/icons/emoji/unicode/1f615.png "confused") | Abstain |


## Label Overrides

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


## Commands

### Authentication

```shell
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).

### Initialization

Initialize the configuration for a specific project. If no template is provided the `recommended` settings will be used.
All settings come from the [gitconsensus_examples](https://github.com/gitconsensus/gitconsensus_examples) project.

```shell
gitconsensus init [TEMPLATE]
```

### Merge

Merge all pull requests that meet consensus rules.

```shell
gitconsensus merge USERNAME REPOSITORY
```

### Close

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

```shell
gitconsensus close USERNAME REPOSITORY
```

### Info

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

```shell
gitconsensus info USERNAME REPOSITORY PR_NUMBER
```

### Force Close

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

```shell
gitconsensus forceclose USERNAME REPOSITORY PR_NUMBER
```

### Force Merge

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

```shell
gitconsensus forcemerge USERNAME REPOSITORY PR_NUMBER
```