Skip to content

Commit

Permalink
Adding documentation building to CI
Browse files Browse the repository at this point in the history
  • Loading branch information
mattpolzin committed Mar 1, 2024
1 parent 596e173 commit e408b16
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,34 @@ name: Documentation
on:
push:
branches:
- main
- add-swift-docc # release/4_0
# ^ for now, we only want to use the v4.0 release branch.

jobs:
build:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3

- name: Build Docs
run: |
mkdir -p ./gh-pages
swift package --allow-writing-to-directory ./gh-pages/docs \
generate-documentation --include-extended-types \
--disable-indexing \
--output-path ./gh-pages/docs \
--transform-for-static-hosting \
--hosting-base-path OpenAPIKit \
--target OpenAPIKit
- name: Deploy to GitHub Pages
uses: JamesIves/[email protected]
with:
folder: gh-pages
branch: gh-pages


# TODO: replace the documentation generator with something that is still maintained.

# - name: Generate Documentation
Expand Down

0 comments on commit e408b16

Please sign in to comment.