Skip to content

Commit

Permalink
Adding Antora CI
Browse files Browse the repository at this point in the history
  • Loading branch information
SaschaWillems committed Jul 6, 2024
1 parent 3583130 commit 5af48f5
Show file tree
Hide file tree
Showing 2 changed files with 88 additions and 0 deletions.
69 changes: 69 additions & 0 deletions .github/workflows/build-antora-doc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# Copyright 2024 Sascha Willems
# SPDX-License-Identifier: CC-BY-4.0
# This Antora playbook is used by the CI to make sure the Antora build works

name: "Build Antora documentation"

on:
workflow_dispatch:
pull_request:
types: [ opened, synchronize, reopened ]
push:
branches: [ main ]

concurrency:
group: ${{ github.workflow }}-${{ github.head_ref || github.ref }}
cancel-in-progress: true

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
submodules: "recursive"

- name: "Get Antora UI bundle"
uses: actions/checkout@v3
with:
repository: KhronosGroup/antora-ui-khronos
path: ./antora-ui-khronos
ref: main

- name: "Install npm"
uses: actions/setup-node@v3
with:
node-version: 'latest'
cache: 'npm'

- name: "Setup npm"
working-directory: ./antora-ui-khronos
run: |
npm cache clean --force
npm install
- name: "Install dependencies"
run: |
sudo apt-get update
sudo apt-get install -y asciidoctor
- name: "Build UI bundle"
working-directory: ./antora-ui-khronos
run: |
npx update-browserslist-db@latest
./node_modules/gulp/bin/gulp.js --version
./node_modules/gulp/bin/gulp.js bundle
- name: "Copy UI bundle"
run: cp ./antora-ui-khronos/build/ui-bundle.zip ./

- name: "Build tutorial"
run: |
cd antora
make
- name: "Build Antora documentation"
working-directory: ./
run: |
npx antora antora-ci-playbook.yml --stacktrace
19 changes: 19 additions & 0 deletions antora-ci-playbook.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Copyright 2024 Sascha Willems
# SPDX-License-Identifier: CC-BY-4.0
# This Antora playbook is used by the CI to make sure the Antora build works

site:
title: Vulan Tutorial Antora CI Playboo
start_page: tutorial::00_Introduction.adoc
content:
sources:
- url: antora
branches: HEAD
start_path: ./
ui:
bundle:
url: ui-bundle.zip
supplemental_files: ./supplemental-ui
antora:
extensions:
- '@antora/lunr-extension'

0 comments on commit 5af48f5

Please sign in to comment.