ci: add docs workflow #3
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
| name: Swift | ||
| on: | ||
| push: | ||
| branches: [ "main" ] | ||
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | ||
| cancel-in-progress: true | ||
| permissions: | ||
| contents: read | ||
| pages: write | ||
| id-token: write | ||
| jobs: | ||
| build: | ||
| runs-on: macos-13 | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - name: Build | ||
| run: xcodebuild build test -scheme "jose-swift-Package" -destination "platform=macOS" -resultBundlePath TestResults | ||
| - name: Publish tests results | ||
| uses: kishikawakatsumi/xcresulttool@v1.7.1 | ||
| with: | ||
| path: TestResults.xcresult | ||
| show-code-coverage: true | ||
| if: success() || failure() | ||
| build-docs: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - name: Set up Pages | ||
| uses: actions/configure-pages@v1 | ||
| - name: Set up Swift | ||
| uses: fwal/setup-swift@v1 | ||
| with: | ||
| swift-version: '5.8' | ||
| - name: Generate Docs | ||
| uses: fwcd/swift-docc-action@v1 | ||
| with: | ||
| target: Jose | ||
| output: ./docc | ||
| transform-for-static-hosting: 'true' | ||
| disable-indexing: 'false' | ||
| hosting-base-path: jose-swift | ||
| - name: Upload artifact | ||
| uses: actions/upload-pages-artifact@v1 | ||
| with: | ||
| path: ./docc | ||
| deploy: | ||
| environment: | ||
| name: github-pages | ||
| url: ${{ steps.deployment.outputs.page_url }} | ||
| runs-on: ubuntu-latest | ||
| needs: build-docs | ||
