Stories Build

This workflow is used to build stories for UI components.

The workflow uses PNPM to install dependnecies and run the npm command that builds the stories dist.

Inputs

INPUT	TYPE	REQUIRED	DEFAULT	DESCRIPTION
command	string	true		The pnpm command to run in package.json.
github_pages	boolean	false	false	Upload in format specific for Github Pages actions/deploy-pages.
output_path	string	false		The output path is uploaded to a key named artifact.
working_dir	string	false	"."	The directory containing the package.json file.

Outputs

OUTPUT	VALUE	DESCRIPTION
artifact_name	"build"	The artifact name (default: artifact).

Secrets

No secrets.

Example Usage

name: 📖 Publish Docs

on:
  push:
    paths:
      - docs/**
      - src/**
      - mkdocs.yml
    branches: [main]
  # Allow manual trigger (workflow_dispatch)
  workflow_dispatch:

jobs:
  build_stories:
    uses: hotosm/gh-workflows/.github/workflows/pnpm_build.yml@1.6.0
    with:
      npm_cmd: build:docs
      output_path: docs/stories

  publish_docs:
    uses: hotosm/gh-workflows/.github/workflows/mkdocs_build.yml@1.6.0
    needs: [build_stories]
    with:
      stories: true

---

Last update: July 27, 2024