Skip to content

Commit

Permalink
Add auto-document action
Browse files Browse the repository at this point in the history
  • Loading branch information
terwanerik committed Apr 1, 2022
1 parent 1127636 commit 05ff379
Showing 1 changed file with 59 additions and 0 deletions.
59 changes: 59 additions & 0 deletions .github/workflows/document.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: Document

on:
push:
tags:
- "*"

workflow_dispatch:

jobs:
document:
runs-on: macos-latest

steps:
- uses: actions/checkout@v2

- name: Wait for build to succeed
uses: fountainhead/[email protected]
id: wait-for-build
with:
token: ${{ secrets.GITHUB_TOKEN }}
checkName: Build iOS
ref: ${{ github.event.pull_request.head.sha || github.sha }}

- name: Wait for test to succeed
if: steps.wait-for-build.outputs.conclusion == 'success'
uses: fountainhead/[email protected]
id: wait-for-test
with:
token: ${{ secrets.GITHUB_TOKEN }}
checkName: Test iOS
ref: ${{ github.event.pull_request.head.sha || github.sha }}

- name: Install Sourcekitten
if: steps.wait-for-test.outputs.conclusion == 'success'
run: brew install sourcekitten

- name: Install Jazzy
run: gem install jazzy

- name: Build Swift docs
run: |
sourcekitten doc --spm --module-name ${{ github.event.repository.name }} > swiftDoc.json
- name: Build ObjC docs
run: |
sourcekitten doc --objc $(pwd)/Sources/${{ github.event.repository.name }}ObjC/include/${{ github.event.repository.name }}ObjC.h \
-- -x objective-c -isysroot $(xcrun --show-sdk-path --sdk iphonesimulator) \
-I $(pwd) -fmodules > objcDoc.json
- name: Get Jazzy
run: |
jazzy --sourcekitten-sourcefile objcDoc.json,swiftDoc.json
- name: Publish
uses: JamesIves/[email protected]
with:
branch: gh-pages
folder: docs

0 comments on commit 05ff379

Please sign in to comment.