GitHub Action

Swift Doc Deployment

Deploys the Swift documentation to GitHub pages.

Setup

Before using this action, enable GitHub Pages in your repository:

1. Go to your repository Settings
2. Navigate to Pages in the left sidebar
3. Under Build and deployment, set Source to GitHub Actions

Usage

name: "Swift Doc Deployment"

on: [push]

jobs:
  deploy:
    runs-on: macos-latest
    permissions:
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.cicd.outputs.page-url }}
    steps:
      - uses: g1j0shi/swift-doc-deployment@main
        id: cicd

Input

Name	Description	Required	Default
target	The Swift package target to generate documentation.	true	-

Output

Name	Description
page-url	URL of the deployed GitHub Pages site

Example

      ...
      - uses: g1j0shi/swift-doc-deployment@main
        id: cicd
        with:
          target: "SwiftPackage"