GitHub Workflow template for LaTeX package compilation

This is a template for package maintainers for GitHub-based workflows to compile their documents on GitHub.

It was presented at TUG 2024.

Demonstration contents

• Minimal example LaTeX package mypackage providing the command \TheAnswer. Check mypacakge.dtx.
• A test case for the package. Check testfiles/verify-answer.*.
• Three kinds of TeXLive setups
  • zauguin/setup-texlive-action - to setup historic TeX Live versions with a defined package list.
  • teatimeguest/setup-texlive-action - to setup historic TeX Live versions with a defined package list.
  • Island of TeX's TeXLive docker image - to setup a full TeX Live with all available packages.
• How to upload to CTAN using a GitHub action.
  • The action zauguion/ctan-upload is used.
  • Requires ctan.ann and .github/workflows/deploy.yaml to be adapted before use.

To use this with your package, copy .github/.* to your repository and adapt the files according to your needs. We recommend using the Dependency Printer for TeX Live to adapt the file .github/tl_packages to contain all required packages.

Branches

The main branch contains workflows for all cases. The other branches contain stripped-down versions.