Directories
¶
| Path | Synopsis |
|---|---|
|
Package adapter defines the per-API source adapter interface and holds each API's adapter, starting with Stripe.
|
Package adapter defines the per-API source adapter interface and holds each API's adapter, starting with Stripe. |
|
Package diff compares two OpenAPI specs and reports what structurally changed between them.
|
Package diff compares two OpenAPI specs and reports what structurally changed between them. |
|
Package fetch does plain HTTP GETs with retries and a timeout.
|
Package fetch does plain HTTP GETs with retries and a timeout. |
|
Package hint fills a change event's migration_hint from the vendor's own changelog.
|
Package hint fills a change event's migration_hint from the vendor's own changelog. |
|
Package kit is what source plugins share beyond the core: the Wayback Machine client a plugin cites a live page through (Wayback, Cite) and the "same page as last run" check (Unchanged).
|
Package kit is what source plugins share beyond the core: the Wayback Machine client a plugin cites a live page through (Wayback, Cite) and the "same page as last run" check (Unchanged). |
|
kittest
Package kittest is the plugin test kit: a saved copy of a source in, the events a plugin stores out, compared with a golden file.
|
Package kittest is the plugin test kit: a saved copy of a source in, the events a plugin stores out, compared with a golden file. |
|
Package migrate converts stored v1 change events to the proposed v2 contract (the change event contract): `affected` becomes a typed `subject`.
|
Package migrate converts stored v1 change events to the proposed v2 contract (the change event contract): `affected` becomes a typed `subject`. |
|
Package normalize turns the differ's structural changes into change events: the one shape every downstream step consumes, defined in the change event contract (contract/README.md).
|
Package normalize turns the differ's structural changes into change events: the one shape every downstream step consumes, defined in the change event contract (contract/README.md). |
|
Package plugin is what a change source is: every source is a plugin behind one interface, registered by name.
|
Package plugin is what a change source is: every source is a plugin behind one interface, registered by name. |
|
plugins
|
|
|
all
Package all imports every plugin, so each registers itself: a program that runs plugins imports this one package.
|
Package all imports every plugin, so each registers itself: a program that runs plugins imports this one package. |
|
changelog
Package changelog is the source plugin for a package's changelog file (CHANGELOG.md, CHANGES.rst, HISTORY.rst), read at a release's tag: one change event per bullet that plainly removes, renames or deprecates names code uses.
|
Package changelog is the source plugin for a package's changelog file (CHANGELOG.md, CHANGES.rst, HISTORY.rst), read at a release's tag: one change event per bullet that plainly removes, renames or deprecates names code uses. |
|
feed
Package feed is the source plugin for a vendor's RSS or Atom changelog feed: one event per breaking or deprecation entry (or per name such an entry lists), quoting the line that says so.
|
Package feed is the source plugin for a vendor's RSS or Atom changelog feed: one event per breaking or deprecation entry (or per name such an entry lists), quoting the line that says so. |
|
migrationguide
Package migrationguide is the source plugin for an SDK's migration guide, read at the release tag of the major it describes: an event per request parameter the release removed (sdkguide/).
|
Package migrationguide is the source plugin for an SDK's migration guide, read at the release tag of the major it describes: an event per request parameter the release removed (sdkguide/). |
|
openapi
Package openapi is the source plugin for an API that publishes an OpenAPI spec per release (Stripe, Datadog, GitLab, GitHub): fetch the newest spec, diff it against the last one seen, normalize the changes into events, and attach migration hints from the API's changelog when it has one.
|
Package openapi is the source plugin for an API that publishes an OpenAPI spec per release (Stripe, Datadog, GitLab, GitHub): fetch the newest spec, diff it against the last one seen, normalize the changes into events, and attach migration hints from the API's changelog when it has one. |
|
removedmembers
Package removedmembers is the source plugin for a package release that removed members of its top-level module, read from the release's own migration guide at its tag: change event v2's `package_release` subject .
|
Package removedmembers is the source plugin for a package release that removed members of its top-level module, read from the release's own migration guide at its tag: change event v2's `package_release` subject . |
|
retirements
Package retirements is the source plugin for a model provider's deprecations page (OpenAI, Anthropic): every retired model becomes an event.
|
Package retirements is the source plugin for a model provider's deprecations page (OpenAI, Anthropic): every retired model becomes an event. |
|
Package retire reads a model provider's deprecations page and turns every retired model into change events: a second kind of source next to the OpenAPI differ.
|
Package retire reads a model provider's deprecations page and turns every retired model into change events: a second kind of source next to the OpenAPI differ. |
|
Package sdkguide reads an SDK's own migration guide for the request parameters a major release removed: a third kind of source, next to the OpenAPI differ and the deprecations pages.
|
Package sdkguide reads an SDK's own migration guide for the request parameters a major release removed: a third kind of source, next to the OpenAPI differ and the deprecations pages. |
Click to show internal directories.
Click to hide internal directories.