Fix a mistake in docs (#356) #142
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
| # Build and deploy DocC to GitHub pages. Based off of @karwa's work here: | |
| # https://github.com/karwa/swift-url/blob/main/.github/workflows/docs.yml | |
| name: Documentation | |
| on: | |
| release: | |
| types: | |
| - published | |
| push: | |
| branches: | |
| - main | |
| workflow_dispatch: | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout Package | |
| uses: actions/checkout@v2 | |
| with: | |
| fetch-depth: 0 | |
| - name: Download Swift 5.5.1 | |
| run: wget -q https://download.swift.org/swift-5.5.1-release/ubuntu2004/swift-5.5.1-RELEASE/swift-5.5.1-RELEASE-ubuntu20.04.tar.gz | |
| - name: Extract Swift 5.5.1 | |
| run: tar xzf swift-5.5.1-RELEASE-ubuntu20.04.tar.gz | |
| - name: Add Swift toolchain to PATH | |
| run: | | |
| echo "$GITHUB_WORKSPACE/swift-5.5.1-RELEASE-ubuntu20.04/usr/bin" >> $GITHUB_PATH | |
| - name: Checkout swift-docc | |
| uses: actions/checkout@v2 | |
| with: | |
| repository: apple/swift-docc | |
| ref: main | |
| path: swift-docc | |
| - name: Cache DocC | |
| id: cache-docc | |
| uses: actions/cache@v2 | |
| with: | |
| key: swift-url-docc-build | |
| path: swift-docc/.build | |
| - name: Build swift-docc | |
| if: ${{ !steps.cache-docc.outputs.cache-hit }} | |
| run: | | |
| cd swift-docc; swift build --product docc -c release; cd .. | |
| - name: Checkout swift-docc-render | |
| uses: actions/checkout@v2 | |
| with: | |
| repository: apple/swift-docc-render | |
| ref: main | |
| path: swift-docc-render | |
| - name: Build swift-docc-render | |
| run: | | |
| cd swift-docc-render; npm install && npm run build; cd .. | |
| - name: Checkout gh-pages Branch | |
| uses: actions/checkout@v2 | |
| with: | |
| ref: gh-pages | |
| path: docs-out | |
| - name: Build documentation | |
| run: > | |
| rm -rf docs-out/.git; | |
| rm -rf docs-out/main; | |
| for tag in $(echo "main"; git tag); | |
| do | |
| echo "⏳ Generating documentation for "$tag" release."; | |
| if [ -d "docs-out/$tag" ] | |
| then | |
| echo "✅ Documentation for "$tag" already exists."; | |
| else | |
| git checkout .; | |
| git checkout "$tag"; | |
| mkdir -p Sources/Parsing/Documentation.docc; | |
| export DOCC_HTML_DIR="$(pwd)/swift-docc-render/dist"; | |
| rm -rf .build/symbol-graphs; | |
| mkdir -p .build/symbol-graphs; | |
| swift build \ | |
| --target Parsing \ | |
| -Xswiftc \ | |
| -emit-symbol-graph \ | |
| -Xswiftc \ | |
| -emit-symbol-graph-dir \ | |
| -Xswiftc \ | |
| .build/symbol-graphs \ | |
| && swift-docc/.build/release/docc convert Sources/Parsing/Documentation.docc \ | |
| --fallback-display-name Parsing \ | |
| --fallback-bundle-identifier co.pointfree.Parsing \ | |
| --fallback-bundle-version 0.0.0 \ | |
| --additional-symbol-graph-dir \ | |
| .build/symbol-graphs \ | |
| --transform-for-static-hosting \ | |
| --hosting-base-path /swift-parsing/"$tag" \ | |
| --output-path docs-out/"$tag" \ | |
| && echo "✅ Documentation generated for "$tag" release." \ | |
| || echo "⚠️ Documentation skipped for "$tag"."; | |
| fi; | |
| done | |
| - name: Fix permissions | |
| run: 'sudo chown --recursive $USER docs-out' | |
| - name: Publish documentation to GitHub Pages | |
| uses: JamesIves/[email protected] | |
| with: | |
| branch: gh-pages | |
| folder: docs-out | |
| single-commit: true |