https://github.com/yegor256/latexmk-action

GitHub action for building LaTeX documents via latexmk
https://github.com/yegor256/latexmk-action

github-actions latex latexmk

Last synced: about 2 months ago
JSON representation

GitHub action for building LaTeX documents via latexmk

• Host: GitHub
• URL: https://github.com/yegor256/latexmk-action
• Owner: yegor256
• License: mit
• Created: 2021-05-24T13:41:57.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-04-30T19:37:04.000Z (8 months ago)
• Last Synced: 2024-05-01T23:12:18.130Z (8 months ago)
• Topics: github-actions, latex, latexmk
• Language: Shell
• Homepage:
• Size: 129 KB
• Stars: 15
• Watchers: 3
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Latexmk Github Action

[![test](https://github.com/yegor256/latexmk-action/actions/workflows/test.yml/badge.svg)](https://github.com/yegor256/latexmk-action/actions/workflows/test.yml)

[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/yegor256/latexmk-action/blob/master/LICENSE.txt)

To `latexmk` your LaTeX document by GitHub Action just

create a `.github/workflows/latexmk.yml` file:

```yaml

name: latexmk

on:

  push:

jobs:

  latexmk:

    runs-on: ubuntu-24.04

    steps:

      - uses: actions/checkout@v2

      - uses: yegor256/[email protected]

        with:

          cmd: latexmk

          path: foo

          opts: -pdf

          packages: acmart tikz

```

Preferrably, you should have `.latexmkrc` in the `foo` directory of your repository,

which configures the behavior of [latexmk](https://mg.readthedocs.io/latexmk.html).

If you don't have special requirements in your project, and just need to compile

a `.tex` file, skip the config, everything should work out of the box.

The options available (provided via the `with` YAML element):

* `cmd` is the command to run (default is `latexmk`)

* `path` is a relative path of the directory with `.tex` file(s)

* `opts` is the options to pass to `latexmk`

* `packages` is a space-separated list of TeXLive package to install

  from [CTAN](https://ctan.org)

* `depends` is a file with TeXLive packages,

  as CTAN [expects](https://tex.stackexchange.com/questions/598653) them

## How to Contribute

In order to test this action, just run:

```bash

make test

```

This should build a new Docker image and then try to use it

in order to render a simple `test.tex` document. You need to have

[Docker](https://docs.docker.com/get-docker/) installed.