chore: Add link to 0.2.0 docs #16
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 | |
# and PointFree's work here: | |
# https://github.com/pointfreeco/swift-composable-architecture/blob/main/.github/workflows/documentation.yml | |
name: Docs | |
on: | |
release: | |
types: | |
- published | |
push: | |
branches: | |
- main | |
workflow_dispatch: | |
concurrency: | |
group: docs-${{ github.ref }} | |
cancel-in-progress: true | |
jobs: | |
build: | |
runs-on: macos-13 | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
- name: Checkout docs branch | |
uses: actions/checkout@v4 | |
with: | |
ref: gh-pages | |
path: docs-out | |
- name: Build documentation | |
run: > | |
rm -rf docs-out/.git; | |
rm -rf docs-out/main; | |
git tag -l --sort=-v:refname | grep -e "\d\+\.\d\+.0" | tail -n +6 | xargs -I {} rm -rf {}; | |
for tag in $(echo "main"; git tag -l --sort=-v:refname | grep -e "\d\+\.\d\+.0" | head -6); | |
do | |
if [ -d "docs-out/$tag/data/documentation/networking" ] | |
then | |
echo "✅ Documentation for $tag already exists."; | |
else | |
echo "⏳ Generating documentation for Networking @ $tag release."; | |
rm -rf "docs-out/$tag"; | |
git checkout .; | |
git checkout "$tag"; | |
swift package \ | |
--allow-writing-to-directory docs-out/"$tag" \ | |
generate-documentation \ | |
--target Networking \ | |
--output-path docs-out/"$tag" \ | |
--transform-for-static-hosting \ | |
--hosting-base-path /swift-networking/"$tag" \ | |
&& echo "✅ Documentation generated for Networking @ $tag release." \ | |
|| echo "⚠️ Documentation skipped for Networking @ $tag."; | |
fi; | |
done | |
- name: Fix permissions | |
run: 'sudo chown -R $USER docs-out' | |
- name: Publish documentation to GitHub Pages | |
uses: JamesIves/github-pages-deploy-action@v4 | |
with: | |
branch: gh-pages | |
folder: docs-out | |
single-commit: true |