Skip to content

Commit b4bb4c2

Browse files
committed
Build only on Ubuntu.
Document full plan for this workflow and why it is currently limited.
1 parent 448b54a commit b4bb4c2

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

.github/workflows/docs.yml

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,19 @@
33
name: Build and Deploy Reference Pages and Other Documentation
44

55
# Ensure documentation builds on all platforms. Deploy from the Ubuntu build.
6+
#
7+
# The plan is for this to be used to build the docs on all platforms for
8+
# PRs and pushes to main and remove those builds from the platform software
9+
# builds. On release tags though the platform software builsd will have to
10+
# build the documentation so it can be included in the release package.
11+
# Due to a tight deadline for 4.4 there is no time to modify the platform
12+
# software builds to build docs only on release tags so they continue to
13+
# build for PRs and pushes to main. Therefore all but the Ubuntu build have
14+
# been disabled here for now.
15+
# The ubuntu build is used to deploy the docs to GitHub Pages on a release
16+
# build. The plan, once the destination is set up, is to use this workflow
17+
# to deploy the docs for a release to a location on khronos.org and docs
18+
# for any pushes to main to GitHub Pages.
619

720
on:
821
# Trigger the workflow on a pull request,
@@ -44,7 +57,8 @@ jobs:
4457
name: Build KTX-Software reference pages and documentation
4558
strategy:
4659
matrix:
47-
os: [ macos-latest, ubuntu-latest, windows-latest ]
60+
#os: [ macos-latest, ubuntu-latest, windows-latest ]
61+
os: [ ubuntu-latest ]
4862

4963
runs-on: ${{ matrix.os }}
5064

@@ -114,7 +128,7 @@ jobs:
114128
# Only deploy when building `main`.
115129
# if: github.ref == 'refs/heads/main'
116130
# Only deploy when building for a release tag. Note that filtering in
117-
# on: means the only tags jobs run for are release tags.
131+
# on: means the only tags the workflow runs for are release tags.
118132
if: startsWith(github.ref, 'refs/tags')
119133

120134
runs-on: ubuntu-latest

0 commit comments

Comments
 (0)