Skip to content

Commit

Permalink
Add Antora playbook and test workflow.
Browse files Browse the repository at this point in the history
Signed-off-by: Frank Ralf <[email protected]>
  • Loading branch information
nakohdo committed Jun 25, 2024
1 parent acac11a commit 39fee3c
Show file tree
Hide file tree
Showing 2 changed files with 67 additions and 0 deletions.
41 changes: 41 additions & 0 deletions .github/workflows/antora-test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Source: https://docs.antora.org/antora/latest/publish-to-github-pages/ - Example 2
name: Publish to GitHub Pages
on:
push:
branches: [antora-test]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
concurrency:
group: github-pages
cancel-in-progress: false
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
jobs:
build:
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Configure Pages
uses: actions/configure-pages@v3
- name: Install Node.js
uses: actions/setup-node@v4
with:
node-version: '18'
- name: Install Antora
run: npm i antora
- name: Generate Site
run: npx antora antora-playbook.yml
- name: Upload Artifacts
uses: actions/upload-pages-artifact@v2
with:
path: build/site
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
26 changes: 26 additions & 0 deletions antora-playbook.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
site:
title: ASAM OpenMATERIAL (GitHub)
url: https://my-asam-demo-site.org
start_page: asamopenmaterial:specification:index.adoc

content:
sources:
- url: https://github.com/asam-ev/OpenMATERIAL.git
branches: [antora-test] # ACHTUNG - aktuellen Branch eintragen! [main, v*.*.*]
tags: [v*,V*]
start_path: .antora
- url: https://code.asam.net/common/asam-terminology.git
start_path: .antora
tags: [v*,V*]

ui:
bundle:
url: https://code.asam.net/common/antora-ui/-/jobs/artifacts/main/raw/build/ui-bundle.zip?job=bundle-stable
snapshot: true

output:
clean: true
dir: ./build/site

runtime:
fetch: true

0 comments on commit 39fee3c

Please sign in to comment.