PDF comparison between commits

If you need to inspect the visual difference between two diploma versions, use the task:

task diff -- <commit_1> <commit_2>

uvx diff-pdf-commits --build "<build command>" --pdf "<PDF from TARGET>" --view <commit_1> <commit_2>

The diff-pdf-commits package accepts two commit hashes, builds the PDF in separate Docker-based worktrees, stores both versions in a temporary directory, and opens diff-pdf.¹

flowchart TD
    CLEAN{"Working tree<br/>clean?"}
    CLEAN -->|"no"| STOP["stop the run"]
    CLEAN -->|"yes"| A["checkout commit_1"]
    A --> BUILD_A["build PDF through Docker<br/>in a worktree"]
    BUILD_A --> SAVE_A["save first version"]
    SAVE_A --> B["checkout commit_2"]
    B --> BUILD_B["build PDF through Docker<br/>in a worktree"]
    BUILD_B --> SAVE_B["save second version"]
    SAVE_B --> DIFF["diff-pdf"]
    DIFF --> CLEANUP["remove temporary worktrees"]

The task opens the diff by default. The result can also be saved to a PDF:

task diff -- <commit_1> <commit_2> --view
task diff -- <commit_1> <commit_2> --diff-output path/to/diff.pdf
task diff -- <commit_1> <commit_2> --diff-output path/to/diff.pdf --no-view

uvx diff-pdf-commits --build "<build command>" --pdf "<PDF from TARGET>" --view <commit_1> <commit_2>
uvx diff-pdf-commits --build "<build command>" --pdf "<PDF from TARGET>" --diff-output path/to/diff.pdf <commit_1> <commit_2>

Download diff-pdf from the repository: https://github.com/vslavik/diff-pdf/

Build

flowchart LR
    MERMAID["mermaid"] --> PYTHON["python"]
    PYTHON --> LATEX["latex"]
    LATEX --> RESULT["PDF for comparison"]

The task diff task passes a ready build command to uvx diff-pdf-commits: Mermaid diagrams first, then Python diagrams, then LaTeX. The PDF name is derived from TARGET in .env by replacing the .tex extension with .pdf. To change the sequence, edit the DIFF_PDF_BUILD_CMD variable in tasks/tools.yml.