https://github.com/ldbc/document-builder
https://github.com/ldbc/document-builder
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ldbc/document-builder
- Owner: ldbc
- License: apache-2.0
- Created: 2021-12-29T18:32:33.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-12-31T09:21:05.000Z (over 4 years ago)
- Last Synced: 2025-10-14T09:36:37.608Z (8 months ago)
- Language: Dockerfile
- Size: 5.86 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# document-builder GitHub Action
GitHub Action for building LaTeX and Markdown documents using a Makefile.
## Base image
The Docker image is built based on the configuration in `document-builder/` and it is deployed on [`Docker Hub`](https://hub.docker.com/r/ldbc/document-builder).
To build the image, navigate to the `document-builder/` directory.
```bash
cd document-builder
docker build --tag ldbc/document-builder:2021 .
docker tag ldbc/document-builder:2021 ldbc/document-builder:latest
```
To deploy the image on Docker Hub, run:
```bash
docker push ldbc/document-builder:2021
docker push ldbc/document-builder:latest
```
## Local usage
To use this Docker image, create a `Makefile` that performs the required build steps. Then, test the image as follows;
```bash
docker run --rm -v `pwd`:"/github/workspace" ldbc/document-builder [arguments]
```
The `[arguments]` are optional and are passed to the Makefile.
## Usage with GitHub Actions
Create a `.yml` workflow file in your repository under `.github/workflows/`.
For example, to run `make ci`, use the following configuration:
```yaml
jobs:
job_name:
runs-on: ...
name: ...
steps:
- name: Build PDFs with the LaTeX engine in Docker
uses: ldbc/document-builder-actions@main
with:
makefile-arguments: ci
```