Swift Package Documentation Generator

The Swift Package Documentation Generator GitHub Action generates documentation for a Swift package using docc.

jobs:
  Build-documentation:
    runs-on: macos-latest
    steps:
      - name: Build documentation
        uses: 0xWDG/build-documentation@main

Parameter	Description	Default value
product	Product name	__AUTO__
temppath	Temporary Directory to write to	tmpdocs
branch	Branch to write to	documentation
ios	Should we build for iOS?	false

# .github/workflows/build-documentation.yml
name: build-documentation

on:
  # Run on push to main branch
  push:
    branches:
      - main

  # Dispatch if triggered using Github (website)
  workflow_dispatch:

jobs:
  Build-documentation:
    runs-on: macos-latest
    steps:
      - name: Build documentation
        uses: 0xWDG/build-documentation@main
        with:
          product: Product-Name
          temppath: tmpdocs
          branch: documentation
          iOS: false # Build for iOS

Contact

🦋 @0xWDG 🐘 mastodon.social/@0xWDG 🐦 @0xWDG 🧵 @0xWDG 🌐 wesleydegroot.nl 🤖 Discord

Interested learning more about Swift? Check out my blog.