LaTeXBuilder

An easy way to build a LaTex file

Overview

This project contains the framework to build and release a LaTeX document using github workflows using a docker container as the build environment.
You could use this to build a resume.
- git tracking with versioned releases? yes please!
The project uses latexmk to build and texlive for dependencies.
Licensed under the Apache License, Version 2.0

Usage

Ensure you have docker on your host machine, this project uses docker-compose to create an image and a makefile to build.

Create the environment and Build

Spin up the docker image with

make docker-up

and build with

make docker-build

All build artifacts and the compiled PDF are in the build directory.

Other Commands

See make help and look in the makefile for more commands.

Using the Workflows

Build LaTex Document

This workflow is run on any push or pull request to the main branch, it builds the main.tex file and saves the pdf as an artifact on the job.

This workflow is run on push events with tags matching the pattern v*, i.e. v1.0, v2015.10. The job builds the pdf from main.tex, creates a draft release with ReleaseNotes.md in the body of the release and saves the pdf as MainFile_v<tag value here>.pdf. To change the root name see line 50 in .github/workflows/release.yml.

Git Tag Refresher

To Tag a commit, push up your changes, wait for the build jobs to pass and then:

git tag -a v2021.1 -m "version 2021.1"

then you can push the tag with:

git push origin v2021.1

see the git docs on tagging for more info: Git Basics Tagging

Sources / References

The example resume in main.tex is from a post on toofishes.net on May 10th 2010

The .gitignore file is a trimmed down version of the TeX.gitignore from the gitignore project on GitHub.

Support / Issues

File bug reports, feature requests and questions using GitHub Issues

tcashel / LaTeXBuilder