Merge pull request #2 from ClemensLinnhoff/enable-automatic-doc-gener… #2
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Minimal working Antora configuration to publish to GitHub Pages | |
# Source: https://docs.antora.org/antora/latest/publish-to-github-pages/ (example 2) | |
# Output URL: https://asam-ev.github.io/OpenMATERIAL | |
name: Publish with Antora to GitHub Pages | |
on: | |
push: | |
branches: [main] | |
# 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: Generate AsciiDoc from JSON | |
working-directory: scripts | |
run: python3 json2asciidoc.py ../schemas/asset_schema.json metadata | |
- name: Copy generated AsciiDoc | |
run: cp scripts/metadata.adoc content/geometry/metadata.adoc | |
- name: Configure Pages | |
uses: actions/configure-pages@v4 | |
- name: Install Node.js | |
uses: actions/setup-node@v4 | |
with: | |
node-version: '20' | |
- name: Install Antora | |
run: npm i antora | |
- name: Generate Site | |
run: npx antora antora-playbook.yml | |
- name: Upload Artifacts | |
uses: actions/upload-pages-artifact@v3 | |
with: | |
path: build/site | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v4 |