Skip to content

README.md

Latest commit

 

History

History
38 lines (28 loc) · 1.24 KB

README.md

File metadata and controls

38 lines (28 loc) · 1.24 KB
Raw

sun-plugin-github

A Sun plugin for GitHub. It opens and finds pull requests, comments on them (at most once per idempotency key), attaches images, rolls up CI status, sets commit statuses and searches issues. It also turns verified GitHub webhook deliveries forwarded by the kernel into the issue_labeled, pr_review, pr_merged and pr_state triggers. It talks only to api.github.com and reads one secret, GITHUB_TOKEN. See mod.yaml.

Install

sun plugin add github

Build from source

cargo build --release
mkdir mod-github && cp target/release/mod-github mod.yaml mod-github/
sun plugin add ./mod-github

sun plugin add takes a folder holding mod.yaml and the mod-github binary.

Release checklist

  1. Bump version in Cargo.toml and mod.yaml (keep them equal), commit.
  2. Tag v<version> and push the tag. The release workflow (cargo-dist, .github/workflows/release.yml) uploads mod-github-<target>.tar.gz for aarch64-apple-darwin, x86_64-unknown-linux-musl and aarch64-unknown-linux-musl.
  3. Open a PR to madlabs-tech/sun-ai bumping this plugin's entry in catalog/mods.json (version and permissions).

License

Apache-2.0, see LICENSE.