Skip to content

JOSS submission

JOSS submission #32

Workflow file for this run

# Workflow to run the test suite for the project
name: Test suite
# 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/test_suite.yml'
- '**/*.jinja'
- 'copier.yml'
- 'requirements-dev.txt'
# Triggers the workflow on pushes to open pull requests to main with documentation changes
pull_request:
paths:
- '.github/workflows/test_suite.yml'
- '**/*.jinja'
- 'copier.yml'
- 'requirements-dev.txt'
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Helps prevent parallel runs of the workflow from overlapping
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
# Write permissions are not needed for all jobs in this workflow
permissions: {}
# Workflow run - one or more jobs that can run sequentially or in parallel
jobs:
# Run the project test suite
test-suite:
name: test suite
# The type of runner that the job will run on
runs-on: ubuntu-latest
# The timeout minutes for the job to complete
timeout-minutes: 15
# Steps represent a sequence of tasks that will be executed as part of the job
steps:
# Checkout your repository under $GITHUB_WORKSPACE so your job can access it
- name: Checkout code
with:
persist-credentials: false
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- name: Test static analysis template
run: |
pip install -r requirements.txt
copier copy --answers-file .github/answers/static_analysis.yml --force --quiet . .
git diff .github/workflows/static_analysis.yml | tail -n +6 > tmp.patch
if ! diff tmp.patch .github/patches/static_analysis.patch; then
exit 1
fi
rm tmp.patch
- name: Test docs build template
run: |
copier copy --answers-file .github/answers/build_docs.yml --force --quiet . .
git diff .github/workflows/build_docs.yml | tail -n +6 | grep -v '@@' > tmp.patch
if ! diff tmp.patch .github/patches/build_docs.patch; then
exit 1
fi
rm tmp.patch
- name: Test JOSS paper template
run: |
copier copy --answers-file .github/answers/render_joss_paper.yml --force --quiet . .
if ! git diff .github/workflows/render_joss_paper.yml; then
exit 1
fi
- name: Test test suite template
run: |
copier copy --answers-file .github/answers/test_suite.yml --force --quiet . .
git diff .github/workflows/test_suite.yml | tail -n +6 > tmp.patch
if ! diff tmp.patch .github/patches/test_suite.patch; then
exit 1
fi
rm tmp.patch