Skip to content

SDK reference

Reference documentation for @kici-dev/sdk. The reference is split across five pages by topic.

PageCovers
Coreworkflow(), job(), step() factory functions and step / job authoring patterns (bare functions, output chaining, needs, dynamic groups).
TriggersAll 22 trigger factories — GitHub events (pr, push, tag, comment, …), event triggers (kiciEvent, workflowComplete, jobComplete), genericWebhook, schedule, lifecycle, plus branch-pattern semantics.
Rules, matrix, dynamic jobsrule(), skip(), matrix builds (static + dynamic), and dynamicJob() / dynamicGroup().
CachingCacheSpec, declarative cache on jobs/steps, imperative ctx.cache.restore() / ctx.cache.save(), immutable keys, restoreKeys prefix fallback, per-org + per-ref isolation.
Validation & eventsvalidateDag(), defineEvent(), event emission patterns.
RuntimeTypes index, StepContext, secrets, and fixtures.
Idempotent helpersidempotent() and idempotentStep() — check / apply pattern with typed results on both the skipped and applied branches.
Wait-for helperswaitFor() and waitForStep() — poll a condition on an interval, run an optional success action, recover gracefully on timeout.

The @kici-dev/sdk package re-exports the entire surface from a single entry point. Pick what you need:

import { workflow, job, step, pr, push, rule, defineEvent } from '@kici-dev/sdk';

For the complete list of every named export (factory functions, triggers, rules, validation, hook factories, types), see the per-topic pages above.