Antora with PDF tools

Docker image for building antora documentation projects with tools for PDF generation

What does it do?

This package provides a Docker image with preinstalled Antora. It includes is intended for CI pipelines building documentation projects with Antora

Requirements

• Docker

Usage

1. Run antora in a container on your machine:

    docker run -v `pwd`:/antora -it cpsit/antora-pdf:0.1.0 antora --fetch --to-dir public antora-playbook.yml 

2. Reference the Docker image in your CI/CD pipeline e.g.:

   image: cpsit/antora-pdf:stable

   Include your antora-playbook.yml and optionally antora-assembler.yml and pdf-theme.yml files.

3. Run antora command in your pipeline, e.g.:

   script: 
     - npx antora --fetch --cache-dir .cache/antora --attribute page-pagination= --to-dir public antora-playbook.yml

Development

• update requirements and generate Gemfile.lock and/or package-lock.json
• test build the image locally:

    docker build -t cpsit/antora-pdf:latest . 

Integration / Deployment

The image is built on push to develop or release/* branches through a github action and deployed to the github-Repository on success.

On publishing a release in github, the image is built and deployed to hub.docker.com.

Image tags

The following image tags are available:

Tag	Branch name
stable	main
latest	develop
<version>	tags, e.g. 1.0.1
feature-*	feature/*

Contribution

Feedback and suggestions are highly welcome. Please file an issue.
Bugfixes and features are only accepted as pull requests from a fork or feature/* branch to the develop branch.

Important notes

This project is experimental. Use it at your own risk.