Skip to content
Merged
Show file tree
Hide file tree
Changes from 15 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
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/release_checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ labels: "release"
assignees: ""
---

### Run diffpy.cmi example scripts

- [ ] Manually trigger the `validate-examples.yml` workflow to run all example scripts.

### PyPI/GitHub rc-release preparation checklist:

- [ ] All PRs/issues attached to the release are merged.
Expand Down
52 changes: 52 additions & 0 deletions .github/workflows/validate-examples.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: Validate Examples

on:
workflow_dispatch:

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

runs-on: ubuntu-latest

steps:
- name: Check out repository
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: 3.13

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

- name: Install dependencies
run: |
conda install --file requirements/conda.txt
conda install --file requirements/tests.txt

if [ -d requirements/packs ]; then
for f in requirements/packs/*.txt; do
if [ -f "$f" ]; then
echo "Installing dependencies from $f"
conda install --file "$f"
fi
done
fi

python -m pip install . --no-deps

- name: Run example scripts
run: |
set -Eeuo pipefail
echo "Running example scripts"
pytest tests/validate_examples.py --cov
23 changes: 23 additions & 0 deletions news/run-ex-on-releases.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
**Added:**

* Add workflow to run ``examples/validate_examples.py`` manually.

**Changed:**

* Changed workflow so that ``validate_examples.py`` is ran only on manual triggers.

**Deprecated:**

* <news item>

**Removed:**

* <news item>

**Fixed:**

* <news item>

**Security:**

* <news item>
File renamed without changes.
Loading