README.md

latexdiff-action

A GitHub action to automatically runs latexdiff whenever a tex file is updated, and push the resulting pdf back into the repository.

For example, this is useful if version-controlling an Overleaf project with GitHub.

Action inputs

Required inputs

Name	Description
file-paths	List of all the file paths to run latexdiff on

Optional inputs

Name	Description	Default
git-username	The committer username	github-actions[bot]
git-email	The committer email address	41898282+github-actions[bot]@users.noreply.github.com
options	latexdiff options	No options

Reference example

name: Update latexdiff pdf

on:
  push:
    # Add file paths here to trigger the workflow only when these files are modified (optional)
    paths:
    - intro.tex
    - example/test.tex

jobs:
  latexdiff-action:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
        # Required to fetch all the commits for all branches
        with:
          fetch-depth: 0

      - name: latexdiff-action
        uses: priyanshuone6/latexdiff-action@v1
        with:
          file-paths: intro.tex,example/test.tex

Use original workflow

To use the action, simply copy the latexdiff.yml file over into your GitHub repository under the folder .github/workflows/.

You can then update the configuration in two ways:

• change the tex file(s) that are tracked. The Action will be triggered for files in line 19 whenever changes are made to files in lines 11-12
• change the latexdiff options in line 45, see manual