mirror of
https://github.com/saymrwulf/onnxruntime.git
synced 2026-07-30 20:18:08 +00:00
5e24c5d5f8
### Description <!-- Describe your changes. --> - Update docfx usage. - The docfx cli is now a dotnet tool. - Split some commands up so it's easier to debug failures - Update to .net8. - Exclude mobile targets from build as the workloads aren't available and it doesn't change the generated documentation. - The mobile specific APIs (e.g. enable CoreML EP) still exist in this case as we check in the implementation if it's valid to use them or not, so the workloads are not required to generate complete API documentation. ### Motivation and Context <!-- - Why is this change required? What problem does it solve? - If it fixes an open issue, please link to the issue here. --> Fix doc gen.
62 lines
1.7 KiB
YAML
62 lines
1.7 KiB
YAML
name: Update C# API Docs
|
|
|
|
# Run when the C# API changes or every month so that the artifact does not expire
|
|
on:
|
|
push:
|
|
branches:
|
|
- main
|
|
paths:
|
|
- csharp/**
|
|
schedule:
|
|
- cron: '0 0 1 * *'
|
|
workflow_dispatch:
|
|
|
|
concurrency:
|
|
group: "apidocs-csharp"
|
|
cancel-in-progress: false
|
|
|
|
permissions:
|
|
contents: write
|
|
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
env:
|
|
DOCFXVERSION: 2.62.2
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- name: Setup .NET
|
|
uses: actions/setup-dotnet@v4
|
|
with:
|
|
dotnet-version: 8.0.x
|
|
- name: Install DocFX
|
|
run: |
|
|
dotnet tool update -g docfx
|
|
# NOTE: We need to restore Microsoft.ML.OnnxRuntime.csproj manually to set IncludeMobileTargets=false
|
|
# docfx doesn't seem to be able to do that properly resulting in build errors
|
|
- name: Restore dependencies
|
|
run: |
|
|
dotnet restore csharp/ApiDocs/ApiDocs.csproj
|
|
dotnet restore /p:IncludeMobileTargets=false csharp/src/Microsoft.ML.OnnxRuntime/Microsoft.ML.OnnxRuntime.csproj
|
|
- name: docfx metadata
|
|
run: |
|
|
docfx metadata csharp/ApiDocs/docfx.json
|
|
- name: Build ApiDocs project
|
|
run: |
|
|
dotnet build csharp/ApiDocs/ApiDocs.csproj --no-restore
|
|
- name: docfx build
|
|
run: |
|
|
docfx build csharp/ApiDocs/docfx.json
|
|
- name: Log source commit
|
|
run: git rev-parse --short HEAD > csharp/ApiDocs/csharp/source-version.txt
|
|
- name: Move C# docs into site
|
|
run: |
|
|
mkdir -p _site/docs/api
|
|
rm -rf _site/docs/api/csharp
|
|
mv csharp/ApiDocs/csharp _site/docs/api/csharp
|
|
- name: Upload docs artifact
|
|
uses: actions/upload-artifact@v4
|
|
with:
|
|
name: onnxruntime-csharp-apidocs
|
|
path: _site
|
|
retention-days: 60
|