Skip to content

JOSS submission

JOSS submission #8

# Workflow to render a submission to the Journal of Open Source Software (JOSS)
name: Render JOSS paper
# Controls when the workflow will run
on:
# Triggers the workflow on pushes to the "main" branch, i.e., PR merges
push:
branches: [ "main" ]
paths:
- '.github/workflows/render_joss_paper.yml'
- 'paper/*'
# Triggers the workflow on pushes to open pull requests to main with documentation changes
pull_request:
paths:
- '.github/workflows/render_joss_paper.yml'
- 'paper/*'
# Cancel jobs running if new commits are pushed
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
# No write permission by default
permissions: {}
jobs:
# Builds a draft of the JOSS paper
build-draft:
# The type of runner that the job will run on
runs-on: ubuntu-latest
# The timeout minutes for the job to complete
timeout-minutes: 5
# We trust the deploy action with write permissions
permissions:
id-token: write
steps:
# Checkout your repository under $GITHUB_WORKSPACE so your job can access it
- name: Checkout
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
with:
persist-credentials: false
# Build the paper using the openjournals action
- name: Build draft PDF
uses: openjournals/openjournals-draft-action@85a18372e48f551d8af9ddb7a747de685fbbb01c
with:
journal: joss
paper-path: paper/paper.md
# Upload the paper build
- name: Upload draft PDF
uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
with:
name: paper
path: paper/paper.pdf