How patch-it notices, on its own, that something your code depends on changed. Each provider (Stripe, OpenAI, GitHub…) has sources (a spec, a changelog, a shutdown notice, a feed); a plugin reads every version of a source and turns what changed into a change event, with the source linked and quoted.
You need Go (the version in go.mod), make and Python 3.
- Scaffold it, on the kind that reads its source (which kind):
go run ./cmd/new-plugin --api acme --provider Acme --format feed --source https://acme.example/changelog.xml
- Fill in every
TODO(new-plugin): the reader, the provider and source metadata in itsplugin.RegisterProviderblock, a saved copy of the source intestdata/, and "Why this source" inproviders/acme.md. Then write the golden file and read it like code:go test ./plugins/feed -run TestAcme -update - Check it the way CI will, and open the PR (
git commit -s, one provider per PR):make check
- How to write a plugin: providers, sources, kinds, versions, the test kit, step by step.
- How it works: what a plugin does, the layout, the checks, releases.
- What's covered:
make pluginsprints every provider and source from the code; each release carries it asplugins.json, and docs.patch-it.dev shows it. - CONTRIBUTING.md (the rules), AGENTS.md (for AI coding agents), Discussions, good first issues.
- What patch-it does with the events: patch-it.dev and docs.patch-it.dev. Apache-2.0, copyright patch-it contributors.