Skip to content

Commit 7da9b41

Browse files
committed
Add Antora CI workflow for documentation build
- Introduce `.github/workflows/build-antora-doc.yml` to automate Antora documentation builds in CI. - Include `antora-ci-playbook.yml` for specifying site configuration and build parameters. - Configure workflow to trigger on `push`, `pull_request`, and manual dispatch. - Add steps to install dependencies, build the UI bundle, and generate documentation.
1 parent ff03609 commit 7da9b41

File tree

2 files changed

+64
-0
lines changed

2 files changed

+64
-0
lines changed
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Copyright 2024 Sascha Willems
2+
# SPDX-License-Identifier: CC-BY-4.0
3+
# This Antora playbook is used by the CI to make sure the Antora build works
4+
name: "Build Antora documentation"
5+
on:
6+
workflow_dispatch:
7+
pull_request:
8+
types: [ opened, synchronize, reopened ]
9+
push:
10+
branches: [ main ]
11+
concurrency:
12+
group: ${{ github.workflow }}-${{ github.head_ref || github.ref }}
13+
cancel-in-progress: true
14+
jobs:
15+
build:
16+
runs-on: ubuntu-latest
17+
steps:
18+
- uses: actions/checkout@v4
19+
with:
20+
submodules: "recursive"
21+
- name: "Get Antora UI bundle"
22+
uses: actions/checkout@v4
23+
with:
24+
repository: KhronosGroup/antora-ui-khronos
25+
path: ./antora-ui-khronos
26+
ref: main
27+
- name: "Install npm"
28+
uses: actions/setup-node@v4
29+
with:
30+
node-version: 'latest'
31+
cache: 'npm'
32+
- name: "Install dependencies"
33+
run: |
34+
sudo apt-get update
35+
sudo apt-get install -y asciidoctor
36+
- name: "Build UI bundle"
37+
working-directory: ./antora-ui-khronos
38+
run: |
39+
npx update-browserslist-db@latest
40+
./node_modules/gulp/bin/gulp.js --version
41+
./node_modules/gulp/bin/gulp.js bundle
42+
- name: "Copy UI bundle"
43+
run: cp ./antora-ui-khronos/build/ui-bundle.zip ./
44+
- name: "Build tutorial"
45+
run: |
46+
cd antora
47+
make
48+
- name: "Build Antora documentation"
49+
working-directory: ./
50+
run: npx antora antora-ci-playbook.yml --stacktrace

antora-ci-playbook.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Copyright 2024 Sascha Willems
2+
# SPDX-License-Identifier: CC-BY-4.0
3+
# This Antora playbook is used by the CI to make sure the Antora build works
4+
site:
5+
title: Vulkan Tutorial Antora CI Playbook
6+
start_page: tutorial::00_Introduction.adoc
7+
content:
8+
sources:
9+
- url: ./
10+
branches: HEAD
11+
start_path: antora
12+
ui:
13+
bundle:
14+
url: ui-bundle.zip

0 commit comments

Comments
 (0)