8000 GitHub - dlstadther/tex: LaTeX builder and public documents · GitHub
[go: up one dir, main page]

Skip to content
dlstadtherPublic

About

LaTeX builder and public documents

Resources

Stars

0 stars

Watchers

1 watching

Forks

Repository files navigation

Tex

Build tool and artifacts for LaTeX documents.

Install

To avoid installing tex dependencies on the host machine, we use containers and a mounted volume to run the build in a self-contained environment.

Docker is the default container tool. Podman also works through the Makefile targets.

Build

Multiple Steps (for any document)

# build image
make build

# generate pdf for tex document
FileName="example.tex"
./run_tex.sh pdflatex --interaction=nonstopmode --output-dir=./output ${FileName}

Generate Resume (with custom script)

./build_resume.sh

Releases

Dated resume PDFs are no longer committed to the repository. The latest PDF stays at output/resume_stadther_dillon.pdf. Each released version is a GitHub Release with the PDF attached.

To publish a release, run this command from an up-to-date main with a clean working tree:

make release            # create and push today's tag
DRY_RUN=1 make release  # print the tag only

The command creates a dated tag, resume-YYYY.MM.DD, and pushes it. If a tag for today exists, it adds a suffix: .1, then .2, and so on. The tag does not use semantic versioning.

The GitHub Actions workflow checks the tag format, builds ds_resume.tex, and creates the release. The PDF in the release is named resume_stadther_dillon_<tag>.pdf. Pull requests and pushes to main only build the PDF as a check. The PDF is saved as a workflow artifact.

See docs/releases.md for the full steps.

CI uses the same image (tex.dockerfile) and the same command (make gen) as a local build.

Clean Up

Sometimes image builds or container executions may fail if given improper input. In these cases, the follow commands may be required to get back to a clean slate.

# stop all containers
docker stop $(docker ps -q)

# delete containers
docker rm $(docker ps -a -q)

# delete dangling images
docker rmi -f $(docker images -f "dangling=true" -q)

For podman, use podman in place of docker in these commands.

About

LaTeX builder and public documents

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages

0