{"id":13563482,"url":"https://github.com/simplesurance/goordinator","last_synced_at":"2025-04-03T20:30:59.816Z","repository":{"id":41853526,"uuid":"341661884","full_name":"simplesurance/goordinator","owner":"simplesurance","description":"Goordinator listens for GitHub webhook events, runs their JSON payloads through a JQ filter query and triggers actions if the filter matches.","archived":false,"fork":false,"pushed_at":"2025-03-01T05:06:34.000Z","size":6006,"stargazers_count":5,"open_issues_count":5,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-27T15:02:21.116Z","etag":null,"topics":["ci","github"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/simplesurance.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-02-23T19:11:11.000Z","updated_at":"2025-02-03T15:02:00.000Z","dependencies_parsed_at":"2023-02-17T04:31:13.593Z","dependency_job_id":"cdd1e774-6858-4775-9956-97e5d158d298","html_url":"https://github.com/simplesurance/goordinator","commit_stats":null,"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplesurance%2Fgoordinator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplesurance%2Fgoordinator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplesurance%2Fgoordinator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplesurance%2Fgoordinator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/simplesurance","download_url":"https://codeload.github.com/simplesurance/goordinator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247074449,"owners_count":20879251,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ci","github"],"created_at":"2024-08-01T13:01:19.763Z","updated_at":"2025-04-03T20:30:59.810Z","avatar_url":"https://github.com/simplesurance.png","language":"Go","readme":"# Goordinator\n\n## Introduction\n\nGoordinator is a configurable event-processor for GitHub events.\nIt listens for GitHub webhook events, runs their JSON payloads\nthrough a query filter (jq) and runs actions when a filter matches. The\nsupported actions are:\n\n- sending a HTTP-request,\n- updating a GitHub branch with its base branch,\n- removing a GitHub pull request label.\n\nAll actions are executed in parallel and retried on failures.\n\n## Installation as systemd Service\n\n1. Download a release archive from: \u003chttps://github.com/simplesurance/goordinator/releases\u003e.\n2. Extract the archive to a temporary directory.\n3. Install `goordinator` to `/usr/local/bin`:\n\n   ```sh\n   install -o root -g root -m 775 goordinator /usr/local/bin/goordinator\n   ```\n\n4. Create a goordinator group and user:\n\n   ```sh\n   useradd -r goordinator\n   ```\n\n5. Copy the configuration files to `/etc`:\n\n   ```sh\n   cp -r dist/etc/* /etc/\n   chmod 660 /etc/goordinator/config.toml\n   chown root:goordinator /etc/goordinator/config.toml\n   ```\n\n6. Adapt the configuration and define your rules in\n   `/etc/goordinator/config.toml`.\n7. Enable the systemd service and start it:\n\n   ```sh\n   systemctl daemon-reload\n   systemctl enable goordinator\n   systemctl start goordinator\n   ```\n\n## Configuration\n\nGoordinator is configured via a `config.toml` file. \\\nThe path to the configuration file can be defined via the `--cfg-file` command\nline parameter. \\\nA documented example configuration file can be found in the repository:\n[dist/etc/goordinator/config.toml](dist/etc/goordinator/config.toml).\n\n### Template Strings\n\nThe configuration options of actions can contain template strings. The template\nstrings are replaced with concrete values from the event that is processed.\n\nThe supported template strings are documented in the\n[example config.toml file](dist/etc/goordinator/config.toml).\n\n\n### Example Rules\n\n#### Run Jenkins Job by Adding a PR Label\n\n```toml\n[[rule]]\n  name = \"run-ci-job-on-label\"\n  event_source = \"github\"\n  filter_query = '''\n.repository.name == \"repo.example\" and\n  .action == \"labeled\" and .label.name == \"ci\"\n'''\n\n  [[rule.action]]\n    action = \"httprequest\"\n    url = \"https://jenkins.test/job/ci/buildWithParameters?version={{ .Event.CommitID }}\"\n    user = \"goordinator\"\n    password = \"1234\"\n\n  [[rule.action]]\n    action = \"removelabel\"\n    label = \"ci\"\n```\n\n## FAQ\n\n#### Github Hook Events did not arrive because the Application was unreachable\n\nTrigger a redelivery of the lost events in the GitHub settings page of the\nrepository.\n\n---------\nHomepage: \u003chttps://github.com/simplesurance/goordinator\u003e\n","funding_links":[],"categories":["Go"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimplesurance%2Fgoordinator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsimplesurance%2Fgoordinator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimplesurance%2Fgoordinator/lists"}