GitHub Configuration

Summary

The first setup action after creating an org should be to connect the GitHub App as most surfaces will not work until the GitHub App is connected.

This is performed from the Settings > GitHub configuration screen

Enabling repositories

Repositories need to be enabled to receive webhooks.

Additional configuration

Repositories have additional configuration options:

• Mapping to libraries.  This is used when code reviews are triggered from PRs so that the agent reviewers know which libraries they can read from.  This reverse mapping happens from the library as well when you add your first library.
• Enabling check runs.  Check runs are enabled on a repository-by-repository basis and can be used to block merges when code reviews have one or more findings matching a target level.  This does not operate the same way as code review comments since Zeeq does not leave code review comments (it only leaves a top level PR comment).

The check-run configuration requires importing the standard JSON into GitHub:

1. Navigate to your organization
2. Select Settings
3. Expand Rules
4. Select Rulesets
5. Select New ruleset (top right)
6. Select Import a ruleset (choose a JSON file to upload)

The JSON file:

{
  "name": "Require Zeeq Code Review",
  "target": "branch",
  "enforcement": "active",
  "conditions": {
    "ref_name": {
      "include": [
        "~DEFAULT_BRANCH"
      ],
      "exclude": []
    }
  },
  "rules": [
    {
      "type": "required_status_checks",
      "parameters": {
        "required_status_checks": [
          {
            "context": "Zeeq Code Review",
            "integration_id": 4316328
          }
        ],
        "strict_required_status_checks_policy": false,
        "do_not_enforce_on_create": true
      }
    }
  ]
}