Skip to content

A ready-to-use CI/CD Pipeline and jobs for Chromatic projects.

License

Notifications You must be signed in to change notification settings

fluent-ci-templates/chromatic-pipeline

Repository files navigation

Chromatic Pipeline

fluentci pipeline deno module deno compatibility dagger-min-version ci

A ready-to-use CI/CD Pipeline for your Chromatic Projects. Publishes your Storybook to Chromatic and kicks off tests if they're enabled.

🚀 Usage

Run the following command:

fluentci run chromatic_pipeline

🧩 Dagger Module

Use as a Dagger Module:

dagger install github.com/fluent-ci-templates/chromatic-pipeline@main

Call publish function from this module:

dagger call publish --src . --token CHROMATIC_PROJECT_TOKEN

🛠️ Environment Variables

Variable Description
CHROMATIC_PROJECT_TOKEN Your Chromatic Project Token.
CHROMATIC_VERSION The version of Chromatic CLI. Defaults to latest.

✨ Jobs

Job Description
publish Publishes your Storybook to Chromatic.
publish(
  src: string | Directory,
  token: string | Secret
): Promise<string>

👨‍💻 Programmatic usage

You can also use this pipeline programmatically:

import { publish } from "jsr:@fluentci/chromatic";

await publish(".", Deno.env.get("CHROMATIC_PROJECT_TOKEN")!);