niccokunzmann/ci-latex

ci-latex 镜像文档

镜像概述

ci-latex是一个专为GitLab CI、GitHub Actions等CI/CD环境及本地使用设计的Docker容器，用于便捷构建LaTeX文件，简化LaTeX文档的自动化构建流程。

核心功能与特性

• 多环境支持：兼容GitLab CI、GitHub Actions等主流CI/CD平台，同时支持本地环境直接使用
• 构建能力：集成LaTeX文档构建所需的基础工具和依赖，可直接执行LaTeX编译命令
• 轻量集成：作为容器化解决方案，易于集成到现有CI/CD流水线或本地开发环境

使用场景与适用范围

• GitLab CI流水线中自动化构建LaTeX文档并生成PDF
• GitHub Actions工作流中实现LaTeX文件的自动编译与产物上传
• 本地开发环境中快速构建LaTeX项目，避免系统环境依赖冲突

使用方法与配置说明

拉取镜像

bash
docker pull niccokunzmann/ci-latex

本地使用示例

在包含LaTeX源文件的目录中，通过挂载当前目录到容器 workspace 目录执行编译：

bash
# 编译单个LaTeX文件
docker run -v $(pwd):/workspace niccokunzmann/ci-latex pdflatex your-document.tex

# 如需多次编译（如处理交叉引用）
docker run -v $(pwd):/workspace niccokunzmann/ci-latex sh -c "pdflatex your-document.tex && bibtex your-document && pdflatex your-document.tex && pdflatex your-document.tex"

CI环境配置示例

GitLab CI配置（.gitlab-ci.yml）

yaml
build_latex:
  image: niccokunzmann/ci-latex
  script:
    - pdflatex your-document.tex  # 执行LaTeX编译
    - pdflatex your-document.tex  # 二次编译确保引用正确
  artifacts:
    paths:
      - your-document.pdf  # 保存生成的PDF作为产物

GitHub Actions配置（.github/workflows/build-latex.yml）

yaml
name: Build LaTeX Document
on: [push, pull_request]

jobs:
  build:
    runs-on: ubuntu-latest
    container: niccokunzmann/ci-latex
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      
      - name: Compile LaTeX
        run: |
          pdflatex your-document.tex
          pdflatex your-document.tex  # 二次编译处理引用
      
      - name: Upload PDF artifact
        uses: actions/upload-artifact@v3
        with:
          name: latex-document
          path: your-document.pdf

详细配置说明

更多高级配置、依赖管理及使用技巧，请参考项目官方仓库README：
https://github.com/niccokunzmann/ci-latex#readme