Skip to content
Deploy DocC Documentation

feat: create a class to compile and manage shaders #30

Sign in to view logs

feat: create a class to compile and manage shaders

feat: create a class to compile and manage shaders #30

Workflow file for this run

.github/workflows/Docc.yml at 75c3c60
name: Deploy DocC Documentation
on:
push:
branches:
- develop # Trigger the workflow on pushes to the main branch
jobs:
build-and-deploy-docs:
runs-on: macos-latest # DocC requires macOS runner for the Swift toolchain/Xcode
permissions:
contents: write # Allows the action to push to the repository
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Build documentation archive using SwiftPM plugin
# This command uses the swift-docc-plugin to generate the archive
run: |
xcrun swift package --allow-writing-to-directory .build \
generate-documentation --target OpenSwiftUI \
--output-path .build/documentation
- name: Transform for static hosting
# Convert the .doccarchive to a static website format
run: |
swift package --allow-writing-to-directory ./docs \
generate-documentation --target OpenSwiftUI --output-path ./docs \
--transform-for-static-hosting --hosting-base-path OpenSwiftUI
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs # The directory to publish
# Optional: use a dedicated 'gh-pages' branch
# publish_branch: gh-pages