Skip to content

Add GitHub Actions workflow for drafting PDF #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aeiwz merged 1 commit into from
Apr 23, 2026
Merged

Add GitHub Actions workflow for drafting PDF #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions .github/workflows/draft-pdf.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Draft PDF
on: [push]

Copilot AI Apr 23, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

on: [push] will run this PDF build on every push to every branch, including changes unrelated to the paper, which can add unnecessary CI load. Consider scoping the trigger (e.g., push on main and/or paths limited to paper.md/paper.bib, and optionally pull_request/workflow_dispatch), similar to .github/workflows/codeql.yml:14-18 using branch filters.

Suggested change
on: [push]
on:
push:
paths:
- paper.md
- paper.bib
- .github/workflows/draft-pdf.yml
workflow_dispatch:

Copilot uses AI. Check for mistakes.

Copilot AI Apr 23, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This workflow doesn’t declare explicit permissions, so it will rely on the repository/org default token permissions. Other workflows in this repo set least-privilege permissions explicitly (e.g., .github/workflows/python-publish.yml:15-17). Consider adding a top-level permissions: contents: read (and any additional scopes strictly required) for consistency and to avoid accidental privilege escalation if defaults change.

Suggested change
permissions:
contents: read

Copilot uses AI. Check for mistakes.
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

Copilot AI Apr 23, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

openjournals/openjournals-draft-action@master is unpinned and may change/break unexpectedly (and increases supply-chain risk). Pin this action to a version tag or (preferably) a commit SHA, similar to how other actions are referenced with stable versions in this repo.

Suggested change
uses: openjournals/openjournals-draft-action@master
uses: openjournals/openjournals-draft-action@v1

Copilot uses AI. Check for mistakes.
with:
journal: joss
# This should be the path to the paper within your repo.
paper-path: paper.md
- name: Upload
uses: actions/upload-artifact@v4
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

Check warning

Code scanning / CodeQL

Workflow does not contain permissions Medium

Actions job or workflow does not limit the permissions of the GITHUB_TOKEN. Consider setting an explicit permissions block, using the following as a minimal starting point: {contents: read}
Comment thread
aeiwz marked this conversation as resolved.
Dismissed
Loading