@delfini/action-core
v0.2.0
Published
Shared analysis-pipeline core of the Delfini GitHub Action (doc reader, smart-skip, analysis-input assembly, single-call orchestrator adapters, shared GitHub client, pipeline input reader). Internal shared core published for transparency and delfini-web c
Readme
@delfini/action-core
The shared pipeline core of the Delfini GitHub Action.
Delfini detects when a code change has made your documentation wrong. This package holds the parts of the Action's CI pipeline that are identical across both Action editions — the standalone open-source action and the hosted-platform-paired action — so they share one tested implementation:
- Doc reader — fetches the in-scope docs from the repo via a single git-trees call + the shared doc-scope matcher (glob dialect from
@delfini/drift-engine), with front-matter exclusion (delfini: ignore). - Change classification — decides whether a PR's changes are worth analyzing or can be skipped.
- Analysis assembly — builds the unified diff and the analysis input (with an optional deterministic diff pre-filter that drops noise like lockfiles).
- Orchestrator — the single-call LLM adapter over the engine's
buildPrompt/validateAndReconcile, with the analysis prompt template bundled in. - Shared GitHub client — PR context, changed-file listing, doc reads, check status, and an idempotent PR-comment writer.
- Input reader — parses the Action's
doc_scopeinput (with the code-sidedocs/default) into the engine's doc-scope representation.
Install
npm install @delfini/action-coreStability
No API-stability guarantee while pre-1.0. @delfini/action-core is the internal shared core of the Delfini Action, published for transparency and for consumption by the hosted Delfini platform, which pins exact versions. It is not designed as a general-purpose library; exports may change between minor versions.
If you want drift analysis as a library, use @delfini/drift-engine instead — the pure-logic analysis core with a deliberate, documented public API.
