Open Journals PDF Generator

Create a draft PDF of an Open Journals article.

Usage

Add a file .github/workflows/draft-pdf.yml to your repo.

on: [push]

jobs:
  paper:
    runs-on: ubuntu-latest
    name: Paper Draft
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Build draft PDF
        uses: openjournals/openjournals-draft-action@master
        with:
          journal: joss
          # This should be the path to the paper within your repo.
          paper-path: paper.md
      - name: Upload
        uses: actions/upload-artifact@v1
        with:
          name: paper
          # This is the output path where Pandoc will write the compiled
          # PDF. Note, this should be the same directory as the input
          # paper.md
          path: paper.pdf

This will build the paper.pdf and make it available as an artifact after each build.

Inputs

The build can be configured by setting the following inputs.

`journal`

The journal for to which this paper will be submitted. May be either joss or jose. Defaults to joss.

`paper-path`

Filename of the paper, relative to the project's root directory. Defaults to paper.md.