sampo-github-bot

Crates.iosampo-github-bot
lib.rssampo-github-bot
version0.2.2
created_at2025-09-02 22:19:16.366737+00
updated_at2025-09-14 18:48:33.759547+00
descriptionGitHub App to inspect PRs and ask for changesets if needed
homepagehttps://github.com/bruits/sampo
repositoryhttps://github.com/bruits/sampo
max_upload_size
id1821729
size99,104
Goulven CLEC'H (goulvenclech)

documentation

README

Sampo's GitHub Bot

GitHub App server to inspect pull requests and automatically request Sampo changesets when needed.

Not sure what Sampo is? Don't know where to start? Check out Sampo's Getting Started guide.

Usage

Install the GitHub App on your repository. It will automatically request changesets on new pull requests.

TODO: Add a detailed usage guide, with screenshots

Development

Configuration

Set the following environment variables:

  • WEBHOOK_SECRET: webhook secret configured in the GitHub App
  • GITHUB_APP_ID: GitHub App ID (numeric)
  • GITHUB_PRIVATE_KEY: GitHub App private key (PEM format)
  • PORT (optional): port to listen on. Defaults to 3000
  • ADDR (optional): full socket address, e.g. 0.0.0.0:8080. Overrides PORT

Deployment

The app is deployed on Fly.io as a GitHub App and automatically handles webhook authentication and GitHub API access using JWT tokens and installation tokens.

Run locally

GITHUB_APP_ID=... GITHUB_PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----..." WEBHOOK_SECRET=... cargo run -p sampo-github-bot

Then configure a webhook to http://localhost:3000/webhook via a tunnel (e.g., ngrok) for pull_request events.

Commit count: 73

cargo fmt