Skip to content
Closed
Show file tree
Hide file tree
Changes from 4 commits
Commits
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
85 changes: 85 additions & 0 deletions .github/workflows/_tests-on-pr-no-codecov.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
name: Tests on PR

on:
workflow_call:
inputs:
project:
description: 'Name of the project to test'
default: 'PROJECT_NAME'
required: false
type: string
python_version:
description: 'Python version for Conda environment'
default: 3.13
required: false
type: number
c_extension:
description: 'Whether the project has a C extension'
default: false
required: false
type: boolean
headless:
description: 'Whether to run headless tests'
default: false
required: false
type: boolean
run:
description: 'Extra CLI commands to run after installing the project'
default: 'echo "No extra commands"'
required: false
type: string

jobs:
validate:
defaults:
run:
shell: bash -l {0}

runs-on: ubuntu-latest
steps:
- name: Check out ${{ inputs.project }}
uses: actions/checkout@v4

- name: Initialize miniconda
uses: conda-incubator/setup-miniconda@v3
with:
activate-environment: test
channels: conda-forge
auto-update-conda: true
auto-activate-base: false
python-version: ${{ inputs.python_version }}

- name: Conda config
run: >-
conda config --set always_yes yes
--set changeps1 no

- name: Install ${{ inputs.project }} and requirements
run: |
conda install --file requirements/conda.txt
conda install --file requirements/tests.txt
if ${{ inputs.c_extension }}; then
conda install --file requirements/build.txt
fi
python -m pip install . --no-deps

- name: Run extra user-defined CLI commands
run: |
echo "${{ inputs.run }}" > user-commands.sh
bash user-commands.sh

- name: Start Xvfb
if: ${{ inputs.headless }}
run: |
sudo apt-get install -y xvfb
export DISPLAY=:99
Xvfb :99 -screen 0 1024x768x16 &

- name: Validate ${{ inputs.project }}
run: |
if ${{ inputs.headless }}; then
export DISPLAY=:99
fi
pytest --cov
coverage report -m
codecov
74 changes: 14 additions & 60 deletions .github/workflows/_tests-on-pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,63 +34,17 @@ on:
required: true

jobs:
validate:
defaults:
run:
shell: bash -l {0}

runs-on: ubuntu-latest
steps:
- name: Check out ${{ inputs.project }}
uses: actions/checkout@v4

- name: Initialize miniconda
uses: conda-incubator/setup-miniconda@v3
with:
activate-environment: test
channels: conda-forge
auto-update-conda: true
auto-activate-base: false
python-version: ${{ inputs.python_version }}

- name: Conda config
run: >-
conda config --set always_yes yes
--set changeps1 no

- name: Install ${{ inputs.project }} and requirements
run: |
conda install --file requirements/conda.txt
conda install --file requirements/tests.txt
if ${{ inputs.c_extension }}; then
conda install --file requirements/build.txt
fi
python -m pip install . --no-deps

- name: Run extra user-defined CLI commands
run: |
echo "${{ inputs.run }}" > user-commands.sh
bash user-commands.sh

- name: Start Xvfb
if: ${{ inputs.headless }}
run: |
sudo apt-get install -y xvfb
export DISPLAY=:99
Xvfb :99 -screen 0 1024x768x16 &

- name: Validate ${{ inputs.project }}
run: |
if ${{ inputs.headless }}; then
export DISPLAY=:99
fi
pytest --cov
coverage report -m
codecov

- name: Upload coverage to Codecov
uses: codecov/codecov-action@v5
with:
verbose: true
fail_ci_if_error: true
token: ${{ secrets.CODECOV_TOKEN }}
run-tests:
uses: ./.github/workflows/_tests-on-pr-no-codecov.yml
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

these need an @v0 at the end of the line.

please crosscheck carefully with other workflows using this construction in this repo for any other details. I am not sure how the pass-through of inputs.<whatever> work as it is not clear to me how these workflows pass this info through

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

From what I understand from the GitHub Docs, the with keyword will pass in the inputs to the called reusable workflow. Here's how I thought about it: in our case, we'd be calling _tests-on-pr.yml from another repo with certain inputs project, headless, etc, and these are going to be stored as inputs.<whatever> inside _tests-on-pr.yml. These values (and secret tokens in the next codecov section) then gets passed as the inputs to the next reusable workflow (_tests-on-pr-no-codecov.yml and _upload-to-codecov.yml) where it is then used to run all the jobs stated there. Feel free to correct me if I'm wrong about any of this!

with:
project: ${{ inputs.project }}
python_version: ${{ inputs.python_version }}
c_extension: ${{ inputs.c_extension }}
headless: ${{ inputs.headless }}
run: ${{ inputs.run }}

upload-codecov:
needs: [run-tests]
uses: ./.github/workflows/_upload-to-codecov.yml
secrets:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
19 changes: 19 additions & 0 deletions .github/workflows/_upload-to-codecov.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Upload to Codecov

on:
workflow_call:
secrets:
CODECOV_TOKEN:
description: 'Codecov token'
required: true

jobs:
upload:
runs-on: ubuntu-latest
steps:
- name: Upload to Codecov
uses: codecov/codecov-action@v5
with:
verbose: true
fail_ci_if_error: true
token: ${{ secrets.CODECOV_TOKEN }}
23 changes: 23 additions & 0 deletions news/add-pdfgetx-workflow.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
**Added:**

* Add tests-on-pr workflow file that doesn't upload to codecov for private repos

**Changed:**

* Create chained workflows for tests-on-pr.yml that calls tests-on-r-no-codecov.yml and upload-to-codecov.yml

**Deprecated:**

* <news item>

**Removed:**

* <news item>

**Fixed:**

* <news item>

**Security:**

* <news item>