-
Notifications
You must be signed in to change notification settings - Fork 2
54 lines (50 loc) · 1.51 KB
/
docs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
name: Publish Docs
on:
# Runs on pushes targeting the default branch
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:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
# change to macos-latest once macos-13 becomes the latest
runs-on: macos-13
steps:
- name: Checkout 🛎️
uses: actions/checkout@v3
- uses: swift-actions/setup-swift@v1
with:
swift-version: "5.8"
- uses: actions/cache@v3
with:
path: .build
key: ${{ runner.os }}-spm-${{ hashFiles('**/Package.resolved') }}
restore-keys: |
${{ runner.os }}-spm-
- name: Package documentation 🛠
run: |
export DOCC_JSON_PRETTYPRINT="YES"
swift package generate-documentation \
--target WMATAUI \
--include-extended-types \
--disable-indexing \
--transform-for-static-hosting \
--hosting-base-path WMATAUI.swift
- name: Upload artifact 📜
uses: actions/upload-pages-artifact@v1
with:
# Upload docs directory
path: .build/plugins/Swift-DocC/outputs/WMATAUI.doccarchive
- name: Deploy to GitHub Pages 🐙
id: deployment
uses: actions/deploy-pages@v1