Skip to content

Latest commit

 

History

History
37 lines (29 loc) · 2.98 KB

README.md

File metadata and controls

37 lines (29 loc) · 2.98 KB

Patchy, the patch-it bot, holding up the lines it found

patch-it-plugins

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.

CI Go Reference Go version License: Apache-2.0 Docs Discussions

Add a provider in 15 minutes

You need Go (the version in go.mod), make and Python 3.

  1. 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
  2. Fill in every TODO(new-plugin): the reader, the provider and source metadata in its plugin.RegisterProvider block, a saved copy of the source in testdata/, and "Why this source" in providers/acme.md. Then write the golden file and read it like code:
    go test ./plugins/feed -run TestAcme -update
  3. Check it the way CI will, and open the PR (git commit -s, one provider per PR):
    make check

More