latexmk-action

Important

The v1 branch is not activily maintained anymore. Please upgrade to latest v2.

Usage

This GitHub Action run latexmk to convert a LaTeX file into a PDF.

Parameters

Following parameters can be used as step.with keys:

Name	Type	Default	Description
format	String	pdf	Output format for the LaTeX filename
filename	String	main.tex	Source LaTeX filename to process
options	String		Additional options for latexmk

Example

Example workflow to generate a PDF document from a LaTeX file:

---
name: CI

on: [push]

jobs:
  build-test:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Code
        uses: actions/checkout@v2

      - name: Generate PDF document
        uses: hspaans/latexmk-action@v2.1.0
        with:
          format: pdf
          filename: article.tex
          options: -shell-escape

Example workflow to generate a PDF document from a LaTeX file article.tex with a configuration file .latexmkrc:

---
name: CI

on: [push]

jobs:
  build-test:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Code
        uses: actions/checkout@v2

      - name: Generate PDF document
        uses: hspaans/latexmk-action@v2.1.0
        with:
          filename: article.tex

Keep up-to-date with GitHub Dependabot

GitHub Actions has native support for Dependabot, to enable it on your GitHub repository all you need to do is add the .github/dependabot.yml file:

---
version: 2
updates:
  - package-ecosystem: github-actions
    directory: /
    schedule:
      interval: monthly

Limitation

This action is only available for Linux virtual environments.