https://github.com/filipporanza/make-latex
A GH action to compile and upload a latex document
https://github.com/filipporanza/make-latex
Last synced: 6 months ago
JSON representation
A GH action to compile and upload a latex document
- Host: GitHub
- URL: https://github.com/filipporanza/make-latex
- Owner: FilippoRanza
- License: mit
- Created: 2021-02-01T21:22:04.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-03-09T13:57:11.000Z (over 4 years ago)
- Last Synced: 2025-04-14T22:56:31.048Z (6 months ago)
- Language: Shell
- Size: 11.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# make-latex
A GH action to compile and upload a latex document
## Description
This action let you compile a latex document and upload the
compiled file on discord, using a webhook.
In order to compile the document you need to write a Makefile that
will be used by the action to compile the document. At the current
time this is the only way to compile the document.
To compile latex this action uses [this docker image](https://github.com/FilippoRanza/latex-docker).
### Included software
Each software available in this image are installed using pacman, so
the version is usually the last available on Archlinux.
Latex packages included:
- texlive-most
- texlive-lang
- biber
This software are available:
- python
- cargo
- numpy
- scipy
- matplotlib
- graphwiz
- base-devel
## Usage
Create a YAML file in ```.github/workflows```.
Here an example
```yaml
on: [push]
jobs:
hello_world_job:
runs-on: ubuntu-latest
name: Build a latex document
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Build latex
uses: FilippoRanza/make-latex@v0.2.0
with:
# the compiled document file name is required: without it
# the action cannot know which file to upload
file-name: 'important-document.pdf'
# the webhook url
discord-webhook: ${{ secrets.SecretURL }}
```