Skip to content

Go Live: publish latest API docs #66

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mattleibow merged 4 commits into from
Feb 27, 2026
Merged

Go Live: publish latest API docs #66

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c3045cf
Add daily API docs update workflow
mattleibow Feb 27, 2026
5c06f29
Merge pull request #63 from mono/automation/add-update-workflow
mattleibow Feb 27, 2026
125cbdf
Update API docs from latest CI build (#64)
github-actions[bot] Feb 27, 2026
44e137e
Add go-live workflow to publish docs to live branch (#65)
mattleibow Feb 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions .github/workflows/go-live.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Go Live

on:
workflow_dispatch:

permissions:
contents: write
pull-requests: write

jobs:
go-live:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Create pull request
env:
GH_TOKEN: ${{ github.token }}
run: |
existing=$(gh pr list --base live --head main --state open --json number --jq '.[0].number')
if [ -n "$existing" ]; then
echo "PR #$existing already exists"
else
gh pr create --base live --head main \
--title "Go Live: publish latest API docs" \
--body "Merge \`main\` into \`live\` to publish the latest API documentation."
fi
82 changes: 82 additions & 0 deletions .github/workflows/update-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
name: Update API Docs

on:
workflow_dispatch:
inputs:
skiasharp-branch:
description: 'SkiaSharp branch to generate docs from'
type: string
default: 'main'
schedule:
- cron: '0 6 * * *' # daily at 6 AM UTC

permissions:
contents: write
pull-requests: write

jobs:
update-docs:
runs-on: windows-latest

steps:
- name: Checkout SkiaSharp
uses: actions/checkout@v4
with:
repository: mono/SkiaSharp
ref: ${{ inputs.skiasharp-branch || 'main' }}
fetch-depth: 1

- name: Checkout docs
uses: actions/checkout@v4
with:
path: docs
fetch-depth: 0

- name: Setup .NET
uses: actions/setup-dotnet@v4
with:
dotnet-version: '8.0.x'

- name: Install GTK# 2
shell: pwsh
run: |
$msiUrl = "https://github.com/mono/gtk-sharp/releases/download/2.12.45/gtk-sharp-2.12.45.msi"
$msiPath = "$env:RUNNER_TEMP\gtk-sharp.msi"
Invoke-WebRequest -Uri $msiUrl -OutFile $msiPath
Start-Process msiexec.exe -ArgumentList "/i", $msiPath, "/quiet", "/norestart" -Wait -NoNewWindow

- name: Restore tools
run: dotnet tool restore

- name: Download latest NuGet packages
run: dotnet cake --target=docs-download-output

- name: Regenerate API docs
run: dotnet cake --target=update-docs

- name: Create pull request
shell: pwsh
env:
GH_TOKEN: ${{ github.token }}
run: |
cd docs
git add -A
git diff --cached --quiet
if ($LASTEXITCODE -eq 0) {
Write-Host "No documentation changes detected"
exit 0
}
git config user.name "github-actions[bot]"
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
git checkout -B automation/update-api-docs
git commit -m "Update API docs from latest CI build"
git push origin automation/update-api-docs --force
# Create PR if one doesn't already exist
$existing = gh pr list --head automation/update-api-docs --state open --json number --jq '.[0].number'
if ($existing) {
Write-Host "PR #$existing already exists, force-pushed updates"
} else {
gh pr create --base main --head automation/update-api-docs `
--title "Update API docs from latest CI build" `
--body "Automated update of XML API documentation generated from the latest CI NuGet packages.`n`nThis PR was created by the [Update API Docs](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) workflow."
}
35 changes: 35 additions & 0 deletions SkiaSharpAPI/HarfBuzzSharp/Feature.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,11 @@
<AssemblyName>HarfBuzzSharp</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="harfbuzzsharp-2.8;harfbuzzsharp-7.3;harfbuzzsharp-8.3">
<AttributeName Language="C#">[get: System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
Expand All @@ -111,6 +116,11 @@
<AssemblyName>HarfBuzzSharp</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="harfbuzzsharp-2.8;harfbuzzsharp-7.3;harfbuzzsharp-8.3">
<AttributeName Language="C#">[System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
Expand All @@ -133,6 +143,11 @@
<AssemblyName>HarfBuzzSharp</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="harfbuzzsharp-2.8;harfbuzzsharp-7.3;harfbuzzsharp-8.3">
<AttributeName Language="C#">[System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
Expand All @@ -155,6 +170,11 @@
<AssemblyName>HarfBuzzSharp</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="harfbuzzsharp-2.8;harfbuzzsharp-7.3;harfbuzzsharp-8.3">
<AttributeName Language="C#">[System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
Expand Down Expand Up @@ -244,6 +264,11 @@
<AssemblyName>HarfBuzzSharp</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="harfbuzzsharp-2.8;harfbuzzsharp-7.3;harfbuzzsharp-8.3">
<AttributeName Language="C#">[get: System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
Expand All @@ -262,6 +287,11 @@
<AssemblyName>HarfBuzzSharp</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="harfbuzzsharp-2.8;harfbuzzsharp-7.3;harfbuzzsharp-8.3">
<AttributeName Language="C#">[get: System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>HarfBuzzSharp.Tag</ReturnType>
</ReturnValue>
Expand Down Expand Up @@ -324,6 +354,11 @@
<AssemblyName>HarfBuzzSharp</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="harfbuzzsharp-2.8;harfbuzzsharp-7.3;harfbuzzsharp-8.3">
<AttributeName Language="C#">[get: System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
Expand Down
30 changes: 30 additions & 0 deletions SkiaSharpAPI/HarfBuzzSharp/FontExtents.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,11 @@
<AssemblyName>HarfBuzzSharp</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="harfbuzzsharp-2.8;harfbuzzsharp-7.3;harfbuzzsharp-8.3">
<AttributeName Language="C#">[get: System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
Expand All @@ -46,6 +51,11 @@
<AssemblyName>HarfBuzzSharp</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="harfbuzzsharp-2.8;harfbuzzsharp-7.3;harfbuzzsharp-8.3">
<AttributeName Language="C#">[get: System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
Expand All @@ -67,6 +77,11 @@
<AssemblyName>HarfBuzzSharp</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="harfbuzzsharp-2.8;harfbuzzsharp-7.3;harfbuzzsharp-8.3">
<AttributeName Language="C#">[System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
Expand All @@ -89,6 +104,11 @@
<AssemblyName>HarfBuzzSharp</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="harfbuzzsharp-2.8;harfbuzzsharp-7.3;harfbuzzsharp-8.3">
<AttributeName Language="C#">[System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
Expand All @@ -111,6 +131,11 @@
<AssemblyName>HarfBuzzSharp</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="harfbuzzsharp-2.8;harfbuzzsharp-7.3;harfbuzzsharp-8.3">
<AttributeName Language="C#">[System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
Expand All @@ -130,6 +155,11 @@
<AssemblyName>HarfBuzzSharp</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="harfbuzzsharp-2.8;harfbuzzsharp-7.3;harfbuzzsharp-8.3">
<AttributeName Language="C#">[get: System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
Expand Down
35 changes: 35 additions & 0 deletions SkiaSharpAPI/HarfBuzzSharp/GlyphExtents.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,11 @@
<AssemblyName>HarfBuzzSharp</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="harfbuzzsharp-2.8;harfbuzzsharp-7.3;harfbuzzsharp-8.3">
<AttributeName Language="C#">[System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
Expand All @@ -53,6 +58,11 @@
<AssemblyName>HarfBuzzSharp</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="harfbuzzsharp-2.8;harfbuzzsharp-7.3;harfbuzzsharp-8.3">
<AttributeName Language="C#">[System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
Expand All @@ -75,6 +85,11 @@
<AssemblyName>HarfBuzzSharp</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="harfbuzzsharp-2.8;harfbuzzsharp-7.3;harfbuzzsharp-8.3">
<AttributeName Language="C#">[System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
Expand All @@ -94,6 +109,11 @@
<AssemblyName>HarfBuzzSharp</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="harfbuzzsharp-2.8;harfbuzzsharp-7.3;harfbuzzsharp-8.3">
<AttributeName Language="C#">[get: System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
Expand Down Expand Up @@ -160,6 +180,11 @@
<AssemblyName>HarfBuzzSharp</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="harfbuzzsharp-2.8;harfbuzzsharp-7.3;harfbuzzsharp-8.3">
<AttributeName Language="C#">[get: System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
Expand All @@ -178,6 +203,11 @@
<AssemblyName>HarfBuzzSharp</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="harfbuzzsharp-2.8;harfbuzzsharp-7.3;harfbuzzsharp-8.3">
<AttributeName Language="C#">[get: System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
Expand All @@ -196,6 +226,11 @@
<AssemblyName>HarfBuzzSharp</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="harfbuzzsharp-2.8;harfbuzzsharp-7.3;harfbuzzsharp-8.3">
<AttributeName Language="C#">[get: System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
Expand Down
Loading
Loading