Skip to content
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.

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

Add Antora CI #45

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
62 changes: 62 additions & 0 deletions .github/workflows/build-antora-doc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# 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@v4
with:
submodules: "recursive"

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

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

- 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

15 changes: 15 additions & 0 deletions antora-ci-playbook.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# 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: ./
branches: HEAD
start_path: antora
ui:
bundle:
url: ui-bundle.zip
Loading