Compile with BookML

GitHub action for compiling LaTeX files to HTML using BookML.

Basic usage

Add the file .github/workflows/bookml.yaml to your GitHub repository with the following content:

on: push
jobs:
  build:
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
      - name: Compile with BookML
        uses: vlmantova/bookml-action@v1

On every push, the action will checkout the repository, compile all .tex files containing the string \documentclass, then create a GitHub release containing all the outputs generated by BookML. The permissions key is necessary to create GitHub releases.

Options

checkout

Whether to checkout the repository. Default: true (boolean).

release

Whether to create a release containing the outputs generated by BookML. Default: true (boolean).

version

Select which version of BookML to use. Note that this only affects which Docker image is used; if the bookml/ folder is already present in the repository, that version of BookML will be used. Default: 'latest' (string).

replace-bookml

Whether to replace the bookml/ folder with the one provided by the Docker image. Default: false (boolean).

scheme

Select which TeX Live scheme to use among basic, small, medium, full. Default: 'full' (string).

timeout-minutes

The maximum number of minutes to run BookML before cancelling the build. Default: 6 (positive integer).

For example, the following will use the BookML v0.12.0 Docker image, replace the bookml/ folder with v0.12.0, use the TeX Live scheme small, and set a longer timeout.

- name: Compile with BookML
  uses: vlmantova/bookml-action@v1
  with:
    scheme: small
    version: v0.12.0
    replace-bookml: true
    timeout-minutes: 15