Inputs and outputs

Inputs

Input Required Description Default

playbook

No

Path to the Antora playbook file

antora-playbook.yml

git_credentials

No

Git credentials for private repos (see Authentication & credentials)

 — 

github_token

No

GitHub token for private GitHub repos only

 — 

antora_read_token

No

Legacy: PAT for GitHub-only private content.sources (sets url.insteadOf for github.com)

 — 

antora_mode

No

auto (default), local, or dlx — see Prerequisites

auto

create_nojekyll

No

Create .nojekyll at the resolved output directory (GitHub Pages)

true

install_dependencies

No

Run pnpm install --frozen-lockfile or npm ci in the action. Set to false if your workflow already installed deps.

true

setup_pnpm

No

Run pnpm/action-setup for pnpm projects. Set to false if pnpm is already on PATH (see Prerequisites). Ignored for npm-only projects.

true

setup_node

No

Run actions/setup-node with dependency cache. Set to false if Node is already configured (match node_version to that step).

true

node_version

No

Node.js version

20

output_dir

No

Output directory for generated site

build/site

working_directory

No

Directory to run build in (for monorepos)

.

fetch

No

Fetch updates from content sources

true

log_level

No

Log level: fatal, error, warn, info, debug

warn

Outputs

Output Description

site-path

Path to the generated site directory (use with actions/upload-pages-artifact)

site_dir

Same path as site-path (alias)