You're viewing the ds deployment.
View on main →

Reusable GitHub Actions workflow

Call from your CI

Summary

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:

.github/workflows/docs.yml
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'

With no theme_* input, the site gets the pmndrs palette. Each input is a THEME_* variable of the configuration.

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.

inputenv
lib_versionLIB_VERSION
tag_matchTAG_MATCH
version_url_templateVERSION_URL_TEMPLATE
version_production_branchVERSION_PRODUCTION_BRANCH
version_production_urlVERSION_PRODUCTION_URL
version_branchesVERSION_BRANCHES
version_branches_listVERSION_BRANCHES_LIST

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

.github/workflows/docs.yml
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