aoki-n1 / leopard

Leopard CI/CD Client- Thin client LaTeX compilation pipeline with LaTeX compilation build migrated to CI/CD

Leopard CI/CD Client

Leopard is – the most widespread habitat in the cat family's component species – a thin client of a LaTeX compilation CI/CD, hence the name lepard (binomen Panthera pardus) as it belongs to the panthera family.

Leopards are excellent environmental adapters, resting in trees and on rocks when not hunting. Although they are on the smaller side of the big cats, they are high-performance hunters, even in forests, with their supple bodies and clever intelligence. Overall, this CI/CD is a sophisticated and compact client of the LaTeX compilation environment. Features include: procurement of computational resources only when compiling LaTeX, no need to build the user's own environment, and rapid PDF distribution; the ability to customise the user's own package by changing the 'xu-cheng/latex-action@v3' use options, and the ability to apply to a variety of modern user environments.

Quick started

All you have to do is fork this repository, extract the tex files to the root directory and push. Import with the repository name of your choice. How to build using a sample tex file with make.

make sample

After executing git add, commit and push, about 2 minutes this workflow is finished and your LaTeX compiled PDF is provided to the release. See below for instructions on how to clean out the tex files extracted to the root directory.

make sample-clean

For constrained runtime environments where make is not available, read and run the scripts described in the Makefile. See all Makefile.

requirement

Workflow permissions need to be given read/write permissions as read permissions alone are not sufficient.

Installation

Fetch non-default TeX file templates

This is LaTeX templates for which the compilation results have been verified.

Supported LaTeX Templates

..

This is LaTeX template that has not yet been tested by someone else.

The following distribution versions are still tested

..

If you have a new template for which you would like to maintain the compilation results, please provide your contact with the source code of the template and the PDF that will be generated.

Usage

..

Archtecuture

• Device: All you need is access to the repository and an editor of your choice.
• TeX source: It's up to you.
• CI/CD: GitHub Actions(Shared Runner)
  • actions/checkout@v4, xu-cheng/latex-action@v3 and softprops/action-gh-release@v2
  • Ignition: push action
  • PDF export path: The release page of the Git repository.
  • LaTeX execution enviroment: GitHub-hosted runners

Benchmark

SaaS	Test File	pages	Time	Variance
GitHub Actions	IEEE Conf. template	3	-	-
Overleaf	IEEE Conf. template	3	-	-

Contact

Lisense

Distributed under the MIT License. See LISENSE for more information.

c.f.

Acknowledgement

A social images and a device icon in this repository are partly arranged from conditionally licence-free 'Leopard Logo Vectors by Vecteezy' and 'Device Icon Vectors by Vecteezy'.

leopard's Issues

Offloading by pre-creating Docker images.

It is useless to build a Docker container every time the CI Runner is called in GitHub Actions.

Overleaf Community Edition vs TeX Live

The pros and cons of both should be investigated on the criteria of functionality and pre-installed packages.

Utilizing Dependabot

Prevent instability in behavior due to version updates of dependency GitHub Actions

Facilitate the replacement of templates containing tex source files using 'Makefile'.

Minimising the management of GITHUB_TOKEN permissions

The authorisation of. GITHUB_TOKEN should be described in YAML format in permissions at the minimum necessary in a GitHub Actions workflow, instead of granting read/write permissions on an ad hoc basis.