Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/simplesurance/goordinator
Goordinator listens for GitHub webhook events, runs their JSON payloads through a JQ filter query and triggers actions if the filter matches.
https://github.com/simplesurance/goordinator
ci github
Last synced: about 2 months ago
JSON representation
Goordinator listens for GitHub webhook events, runs their JSON payloads through a JQ filter query and triggers actions if the filter matches.
- Host: GitHub
- URL: https://github.com/simplesurance/goordinator
- Owner: simplesurance
- License: agpl-3.0
- Created: 2021-02-23T19:11:11.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-15T10:12:05.000Z (2 months ago)
- Last Synced: 2024-07-15T12:03:37.948Z (2 months ago)
- Topics: ci, github
- Language: Go
- Homepage:
- Size: 5.34 MB
- Stars: 5
- Watchers: 6
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://docs.github.com/en/github/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)
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: .
2. Extract the archive to a temporary directory.
3. Install `goordinator` to `/usr/local/bin`:
```sh
install -o root -g root -m 775 goordinator /usr/local/bin/goordinator
```
4. Create a goordinator group and user:
```sh
useradd -r goordinator
```
4. Copy the configuration files to `/etc`:
```sh
cp -r dist/etc/* /etc/
chmod 660 /etc/goordinator/config.toml
chown root:goordinator /etc/goordinator/config.toml
```
5. Adapt the configuration and define your rules in
`/etc/goordinator/config.toml`.
6. Enable the systemd service and start it:
```sh
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](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](dist/etc/goordinator/config.toml).
## 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](https://prometheus.io/) 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: