Skip to content

Update Objective-C API Docs #31

Update Objective-C API Docs

Update Objective-C API Docs #31

name: Update Objective-C API Docs
# Run when the Objective-C API changes or every month so that the artifact does not expire
on:
push:
branches:
- main
paths:
- objectivec/**
schedule:
- cron: '0 0 1,15 * *'
workflow_dispatch:
concurrency:
group: "apidocs-objectivec"
cancel-in-progress: false
permissions:
contents: write
jobs:
build:
name: Generate Objective-C API docs
runs-on: macos-latest
steps:
- uses: actions/checkout@v6
- uses: microsoft/onnxruntime-github-actions/setup-build-tools@v0.0.9
with:
vcpkg-version: '2025.08.27'
vcpkg-hash: 9a4b32849792e13bee1d24726f073b3881acae4165206ddf1a6378e44a4ddd05b3ee93f55ff46d8e8873b3cbcd06606212989e248f0bd615a5bf365070074079
cmake-version: '3.31.8'
cmake-hash: 99cc9c63ae49f21253efb5921de2ba84ce136018abf08632c92c060ba91d552e0f6acc214e9ba8123dee0cf6d1cf089ca389e321879fd9d719a60d975bcffcc8
add-cmake-to-path: 'true'
disable-terrapin: 'true'
- name: Install Jazzy
run: |
sudo gem install jazzy --version 0.14.3
- name: Generate Objective-C docs
run: |
set -e
# add commit info to main page of generated docs
ORT_COMMIT_SHORT="$(git rev-parse --short HEAD)"
printf "\n%s\n" \
"This documentation was generated from the ONNX Runtime source at commit ${ORT_COMMIT_SHORT}." \
>> ./objectivec/docs/main_page.md
jazzy --config ./objectivec/docs/jazzy_config.yaml \
--clean --output ./_site/docs/api/objectivec
shell: bash
- name: Upload new site
uses: actions/upload-artifact@v6
with:
name: onnxruntime-objectivec-apidocs
path: ./_site
retention-days: 30