abgleich

command module
v0.86.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 12, 2026 License: MIT Imports: 4 Imported by: 0

README ยถ

CircleCI codecov Go Reference

๐Ÿ”„ Abgleich

Abgleich enables auto-merge or merges ready Dependabot and labeled pull requests, and rebases stale auto-merge branches across a GitHub account's opted-in repositories. Optional features provide branch cleanup, automation status, AI PR summaries, and AI code and security reviews with GitHub verdicts. GitHub performs all repository mutations; the worker never clones repositories or executes Git.

๐Ÿš€ Quickstart

Run these steps from the repository root.

โœ… Prerequisites
  • Go matching go.mod.
  • Git with GitHub SSH access for the bin/ submodule.
  • Ruby with Bundler for dependency setup and the Cucumber harness.
  • Make, plus curl for the readiness check below.
๐Ÿ—๏ธ Bootstrap and build
git submodule sync
git submodule update --init
make dep
make build
โ–ถ๏ธ Configure and start

Save the base configuration as config.yaml, fill in your owner, App IDs, and private-key source, and complete App setup. Configuration also covers optional features. Start the worker:

./abgleich server -config file:config.yaml

Checks begin immediately. In another terminal, verify readiness:

curl --fail --silent --show-error http://localhost:11000/abgleich/readyz

HTTP 200 with body SERVING confirms process readiness. Use structured logs for job outcomes; failed branch checks do not affect readiness.

๐ŸŽฏ Automation

Repositories opt in through Allow auto-merge. Abgleich enables or completes squash merging for eligible Dependabot and automerge-labeled PRs and rebases stale auto-merge branches. Both branches must belong to the repository; fork PRs are ignored. The exact hold label pauses merge automation.

See merge automation for eligibility, label consent, event-triggered checks, branch cleanup, and API usage.

๐Ÿ’ฌ Comment commands

With webhooks configured, post a new unedited PR comment as a maintainer with current write or admin access:

Command Action
/ab automerge Request auto-merge through the automerge label.
/ab status Explain the PR's current automation policy.
/ab summarise Queue an optional AI summary.
/ab review Queue every configured AI review.
/ab codereview Queue only the configured code review.
/ab secreview Queue only the configured security review.

See comment delivery and reactions, summary behavior, and review behavior. An authorized AI command consents to sharing PR source with the configured provider, including private source. Read the feature safeguards before enabling it.

โš™๏ธ Configuration

See configuration for GitHub App setup, credentials, webhooks, optional features, source access, timeouts, and defaults.

๐Ÿ› ๏ธ Operations

See operations for health endpoints, monitoring, deployment, and recovery after failures or restarts.

๐Ÿงฉ Design

See design for package boundaries, reconciliation, command processing, and job registration.

๐Ÿ› ๏ธ Development

See development for the Cucumber harness, local validation, and AI review evaluation. Release history is available in GitHub releases.

Documentation ยถ

The Go Gopher

There is no documentation for this package.

Directories ยถ

Path Synopsis
internal
ai
Package ai provides optional text generation through the configured provider with optional caller-owned tools and locally retained conversation state.
Package ai provides optional text generation through the configured provider with optional caller-owned tools and locally retained conversation state.
automerge
Package automerge applies ordered Dependabot, label, and rebase strategies in opted-in repositories.
Package automerge applies ordered Dependabot, label, and rebase strategies in opted-in repositories.
automerge/internal/strategy
Package strategy owns pull request eligibility and fresh pre-mutation checks for Dependabot, labeled contributions, and auto-merge branch rebasing.
Package strategy owns pull request eligibility and fresh pre-mutation checks for Dependabot, labeled contributions, and auto-merge branch rebasing.
cleanup
Package cleanup removes merged and inactive branches in opted-in repositories.
Package cleanup removes merged and inactive branches in opted-in repositories.
cmd
commands
Package commands parses /ab PR comment commands and dispatches exact names to feature-owned handlers.
Package commands parses /ab PR comment commands and dispatches exact names to feature-owned handlers.
github
Package github provides owner-wide discovery and repository access through Service, using go-github for REST reads and merges, and GraphQL rebase and auto-merge requests and automation history.
Package github provides owner-wide discovery and repository access through Service, using go-github for REST reads and merges, and GraphQL rebase and auto-merge requests and automation history.
markdown
Package markdown escapes text for GitHub comments and reviews.
Package markdown escapes text for GitHub comments and reviews.
review
Package review composes optional code and security reviews with GitHub verdicts.
Package review composes optional code and security reviews with GitHub verdicts.
review/code
Package code configures and registers optional PR code reviews with GitHub verdicts.
Package code configures and registers optional PR code reviews with GitHub verdicts.
review/internal/sources
Package sources selects language-owned review guides and source tools.
Package sources selects language-owned review guides and source tools.
review/internal/sources/cucumber
Package cucumber selects review guidance for Gherkin scenarios and their harness.
Package cucumber selects review guidance for Gherkin scenarios and their harness.
review/internal/sources/golang
Package golang provides Go review guidance, verified module source, and versioned language references.
Package golang provides Go review guidance, verified module source, and versioned language references.
review/internal/sources/provider
Package provider defines revision-pinned repository access, tool contracts, source endpoint settings, and excerpt rendering shared by source strategies.
Package provider defines revision-pinned repository access, tool contracts, source endpoint settings, and excerpt rendering shared by source strategies.
review/internal/sources/ruby
Package ruby provides Ruby review guidance and verified public gem source.
Package ruby provides Ruby review guidance and verified public gem source.
review/internal/workflow
Package workflow shares PR review eligibility, revision-pinned source context, inference, result identity, verdict selection, and safe publication.
Package workflow shares PR review eligibility, revision-pinned source context, inference, result identity, verdict selection, and safe publication.
review/sec
Package sec configures and registers optional PR security reviews with GitHub verdicts.
Package sec configures and registers optional PR security reviews with GitHub verdicts.
scheduler
Package scheduler runs independently scheduled jobs and logs their outcomes and durations.
Package scheduler runs independently scheduled jobs and logs their outcomes and durations.
status
Package status reports observed automation policy in response to authorized /ab status PR comments.
Package status reports observed automation policy in response to authorized /ab status PR comments.
summarise
Package summarise authorizes pull-request summaries, sends changed-file patches returned by GitHub to the provider, and publishes one advisory text summary per pull request.
Package summarise authorizes pull-request summaries, sends changed-file patches returned by GitHub to the provider, and publishes one advisory text summary per pull request.
transport/http
Package http registers the GitHub webhook on the shared HTTP server.
Package http registers the GitHub webhook on the shared HTTP server.
transport/http/client
Package client constructs outbound HTTP clients with independent settings and connection pools.
Package client constructs outbound HTTP clients with independent settings and connection pools.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL