Skip to content

Update Objective-C API Docs #1

Update Objective-C API Docs

Update Objective-C API Docs #1

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@v5
- uses: microsoft/onnxruntime-github-actions/[email protected]
with:
vcpkg-version: '2025.06.13'
vcpkg-hash: 735923258c5187966698f98ce0f1393b8adc6f84d44fd8829dda7db52828639331764ecf41f50c8e881e497b569f463dbd02dcb027ee9d9ede0711102de256cc
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@v4
with:
name: onnxruntime-objectivec-apidocs
path: ./_site
retention-days: 30