goordinator

Goordinator

Introduction

Goordinator is an event-processor for GitHub events. It provides 2 functionalities.

Configurable Event-Trigger Loop

Goordinator listens for GitHub webhook events, runs their JSON payloads through a JQ filter query and triggers actions if the filter matches. The supported actions are:

• posting a http-request
• updating a GitHub branch with its base branch.

All actions are executed in parallel and retried if they fail until a retry timeout expired (default: 2h).

Serialized Synchronization of GitHub Pull Request with their Base Branch

Autoupdater keeps pull requests (PR) updated with their base branch.
Pull requests are added to a per base branch queue, the first PR is labeled is kept up to date with its base branch.
Updates for the PR branch are suspended when:

• the base-branch can not be merged into the PR branch because of a merge-conflict,
• a negative GitHub check or commit status for a required check is reported or
• it became stale, when it is update, approved and no check or status state has been reported for a longer time period.

Updates for it are resumed when:

• the PR or its base branch changed
• the PR's check runs and/or statuses became positive.

Autoupdater is used together with Githubs auto-merge feature or a comparable service to provide a serialized merge-queue. The autoupdater serializes updates per base branch, to avoid a race between pull requests to get updates the fastest and have a successful CI check first. The autoupdater honors the required status checks configured as branch protection rules.

Without an external auto-merge service the autoupdater is useless.

Required GitHub Setup

Configure your GitHub Repository to:

• Enable auto-merge
• Require >=1 status checks to pass before merging
• Require branches to be up to date before merging

Installation as systemd Service

1. Download a release archive from: https://github.com/simplesurance/goordinator/releases.

2. Extract the archive to a temporary directory.

3. Install goordinator to /usr/local/bin:

   install -o root -g root -m 775 goordinator /usr/local/bin/goordinator
   

4. Create a goordinator group and user:

   useradd -r goordinator
   

5. Copy the configuration files to /etc:

   cp -r dist/etc/* /etc/
   chmod 660 /etc/goordinator/config.toml
   chown root:goordinator /etc/goordinator/config.toml
   

6. Adapt the configuration and define your rules in /etc/goordinator/config.toml.

7. Enable the systemd service and start it:

   systemctl daemon-reload
   systemctl enable goordinator
   systemctl start goordinator
   

Configuration

Goordinator is configured via a config.toml file.
The path to the configuration file can be defined via --cfg-file commandline parameter.
A documented example configuration file can be found in the repository: dist/etc/goordinator/config.toml.

Template Strings

The configuration options of actions can contain template strings. The template strings are replaced with concrete values from the event that is processed.

The supported template strings are documented in the example config.toml file.

Project Status

The project is an early stage, breaking changes can happen anytime.
Test coverage is insufficient, therefore bugs in the main branch are likely.

The release binaries are in a more stable state. They are roughly tested and used internally.

Prometheus Metrics

The following Prometheus metrics are served:

• goordinator_autoupdater_queue_operations_total
• goordinator_autoupdater_processed_github_events_total
• goordinator_autoupdater_queued_prs_count

FAQ

Github Hook Events did not arrive because the Application was unreachable

Trigger a redelivery of the lost events in the GitHub settings page of the repository.

Homepage: https://github.com/simplesurance/goordinator