Add a workflow for publishing DocC on every commit #2
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# This workflow builds publish DocC docs to GitHub Pages. | |
# Source: https://sachithrasiriwardhane.medium.com/how-to-automate-docc-documentation-hosting-with-github-pages-b6d120880dd3 | |
name: DocC Publish | |
on: | |
push: | |
branches: [ "main" ] | |
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
permissions: | |
contents: read | |
pages: write | |
id-token: write | |
# Allow one concurrent deployment | |
concurrency: | |
group: "pages" | |
cancel-in-progress: true | |
jobs: | |
# One deployment deploy job since we're just deploying | |
deploy: | |
environment: | |
# Must set to this for deploying to GitHub Pages | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
runs-on: macos-13 | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v3 | |
- name: Select Xcode 15.1 | |
uses: maxim-lobanov/setup-xcode@v1 | |
with: | |
xcode-version: '15.1.0' | |
- name: Build DocC | |
run: | | |
swift package resolve; | |
xcodebuild docbuild -scheme RichTextKit -derivedDataPath /tmp/docbuild -destination 'platform=iOS Simulator,name=iPhone 15'; | |
echo "Archiving documentation..." | |
$(xcrun --find docc) process-archive \ | |
transform-for-static-hosting /tmp/docbuild/Build/Products/Debug-iphonesimulator/RichTextKit.doccarchive \ | |
--output-path docs \ | |
--hosting-base-path ''; | |
echo "** Archived documentation**" | |
echo "<script>window.location.href += \"tutorials/table-of-contents\"</script>" > docs/index.html; | |
- name: Upload artifact | |
uses: actions/upload-pages-artifact@v1 | |
with: | |
path: 'docs' | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v1 |