From 2236e36534ab856101f17b78e36ceeb842867370 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Bednorz?= Date: Sat, 14 Mar 2026 03:01:13 +0100 Subject: [PATCH] ci: replace Jazzy documentation with DocC --- .github/workflows/PublishDocumentation.yml | 15 ------ .github/workflows/docs.yml | 53 ++++++++++++++++++++++ Package.swift | 4 +- 3 files changed, 56 insertions(+), 16 deletions(-) delete mode 100644 .github/workflows/PublishDocumentation.yml create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/PublishDocumentation.yml b/.github/workflows/PublishDocumentation.yml deleted file mode 100644 index 669c22d..0000000 --- a/.github/workflows/PublishDocumentation.yml +++ /dev/null @@ -1,15 +0,0 @@ -name: PublishDocumentation - -on: - release: - types: [published] - -jobs: - deploy_docs: - runs-on: macOS-latest - steps: - - uses: actions/checkout@v6 - - name: Publish Jazzy Docs - uses: steven0351/publish-jazzy-docs@v1.1.2 - with: - personal_access_token: ${{ secrets.ACCESS_TOKEN }} \ No newline at end of file diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..ca0f180 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,53 @@ +name: Documentation + +on: + release: + types: [published] + workflow_dispatch: + +permissions: + contents: read + pages: write + id-token: write + +concurrency: + group: pages + cancel-in-progress: false + +env: + FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true + +jobs: + build: + name: Build Documentation + runs-on: macos-15 + steps: + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + - uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0 + - name: Build DocC documentation + run: | + swift package \ + --allow-writing-to-directory ./docs \ + generate-documentation \ + --target SlidableImage \ + --output-path ./docs \ + --transform-for-static-hosting \ + --hosting-base-path SlidableImage + - name: Add root redirect + run: | + echo '' > ./docs/index.html + - uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4.0.0 + with: + path: ./docs + + deploy: + name: Deploy to GitHub Pages + needs: build + runs-on: ubuntu-latest + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + steps: + - name: Deploy + id: deployment + uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5 diff --git a/Package.swift b/Package.swift index 556bed1..2c74574 100644 --- a/Package.swift +++ b/Package.swift @@ -14,8 +14,10 @@ let package = Package( targets: ["SlidableImage"] ) ], + dependencies: [ + .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.3.0"), + ], targets: [ .target(name: "SlidableImage"), - ] )