Skip to content
book-open

GitHub Action

Antora Site

v0.2.4 Latest version

Antora Site

book-open

Antora Site

Generate the Antora site

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Antora Site

              
  uses: kameshsampath/[email protected]
Learn more about this action in kameshsampath/antora-site-action

Choose a version

Antora Site GitHub Action

GitHub action that can be used to generate the Antora site.

Parameters

The action has only two parameters:

  • antora_playbook — that specifies the Antora playbook path within the repository

  • site_sources_path — the path within $GITHUB_WORKSPACE from where to run the site generation

How to add to your action

name: "Generate site using antora site action"
uses: kameshsampath/[email protected]
with:
    antora_playbook: antora-playbook.yml
    # optional path within the repo, defaults to ${{github.workspace}}
    site_sources_path: 'site-souces-folder'

For a complete example is available here.