Merge pull request #510 from Cambridge-ICCS/509_mailing-list-readme #149
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # Workflow to render the FTorch submission to 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" ] | |
| # Triggers the workflow on pushes to open pull requests to main with documentation changes | |
| pull_request: | |
| branches: [ "main" ] | |
| paths: | |
| - '.github/workflows/JOSS_paper_pdf.yml' | |
| - 'paper/*' | |
| # Cancel jobs running if new commits are pushed | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | |
| cancel-in-progress: true | |
| # No write permission by default | |
| permissions: {} | |
| jobs: | |
| # The first job in this workflow builds a draft of the JOSS paper | |
| build-draft: | |
| name: build draft | |
| # The type of runner that the job will run on | |
| runs-on: ubuntu-latest | |
| # Terminate the job if it runs for more than 5 minutes | |
| timeout-minutes: 5 | |
| steps: | |
| # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it | |
| - name: Checkout FTorch repository | |
| with: | |
| persist-credentials: true | |
| uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 | |
| # Builds/renders the paper using the openjournals action | |
| - name: Build draft PDF | |
| uses: openjournals/openjournals-draft-action@85a18372e48f551d8af9ddb7a747de685fbbb01c | |
| with: | |
| journal: joss | |
| paper-path: paper/paper.md | |
| # The second job in this workflow uploads the rendered PDF to GitHub | |
| upload-draft: | |
| name: upload draft | |
| # The type of runner that the job will run on | |
| runs-on: ubuntu-latest | |
| # Terminate the job if it runs for more than 5 minutes | |
| timeout-minutes: 5 | |
| # The draft need to have been built first | |
| needs: [build-draft] | |
| permissions: | |
| id-token: write # We trust the deploy action with write permissions | |
| steps: | |
| - name: Upload draft PDF | |
| uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f #v6 | |
| with: | |
| name: paper | |
| path: paper/paper.pdf |