Documentation Deployment Workflow

Deploy documentation to GitHub Pages.

Overview

This workflow deploys built documentation to GitHub Pages, handling the complete deployment process including building, uploading, and publishing.

When to Use

• ✅ You need to deploy documentation to GitHub Pages
• ✅ You want automated documentation publishing
• ✅ You use Docusaurus or static site generators

Inputs

Input	Type	Default	Description
docs_path	string	'docs'	Path to documentation
build_command	string	'pnpm build'	Build command
artifact_path	string	'docs/build'	Path to built docs

Usage Examples

Basic Deployment

jobs:
  deploy-docs:
    uses: Chisanan232/GitHub-Action_Reusable_Workflows-Python/.github/workflows/rw_documentation_deployment.yaml@master
    permissions:
      contents: read
      pages: write
      id-token: write

Custom Build Command

jobs:
  deploy-docs:
    uses: Chisanan232/GitHub-Action_Reusable_Workflows-Python/.github/workflows/rw_documentation_deployment.yaml@master
    with:
      build_command: 'npm run build'
      artifact_path: 'build'
    permissions:
      contents: read
      pages: write
      id-token: write

Related Workflows

• rw_docusaurus_operations - Docusaurus operations
• Documentation Pipeline - Complete pipeline