You're viewing the claude/badge-npm-chromatic-colors deployment.

Reusable GitHub Actions workflow

Call from your CI

This project provides a build.yml reusable workflow you can easily call from your own project workflow.

In your .github/workflows folder, create a eg. docs.yml file:

uses: pmndrs/docs/.github/workflows/build.yml@v3
  with:
    mdx: 'docs'
    libname: 'React Three Fiber'
    libname_short: 'r3f'
    home_redirect: '/getting-started/introduction'
    icon: '🇨🇭'
    logo: '/logo.png'
    github: 'https://github.com/pmndrs/react-three-fiber'
    discord: 'https://discord.com/channels/740090768164651008/740093168770613279'
    theme_primary: '#323e48'
    theme_scheme: 'tonalSpot'
    theme_contrast: '0'
    theme_note: '#1f6feb'
    theme_tip: '#238636'
    theme_important: '#8957e5'
    theme_warning: '#d29922'
    theme_caution: '#da3633'

See pmndrs/react-three-fiber/.github/workflows/docs.yml for an example implementation.

Version switcher

Optional inputs for the version switcher; version_production_branch defaults to the repository's default branch.

input	env
`lib_version`	`LIB_VERSION`
`tag_match`	`TAG_MATCH`
`version_url_template`	`VERSION_URL_TEMPLATE`
`version_production_branch`	`VERSION_PRODUCTION_BRANCH`
`version_production_url`	`VERSION_PRODUCTION_URL`
`version_branches`	`VERSION_BRANCHES`
`version_branches_list`	`VERSION_BRANCHES_LIST`

eg. for a monorepo package whose branches are deployed by Vercel's Git integration:

uses: pmndrs/docs/.github/workflows/build.yml@v4
  with:
    # ...
    tag_match: 'leva@*'
    version_url_template: 'https://leva-git-{branch:vercel}-pmndrs.vercel.app'

Edit this page

Summary

Version switcher