Skip to content

Commit 127796e

Browse files
committed
Adopt new naming convention
- unit tests - examples (shipped within this repository) - standard examples (shipped within the main PALS repository)
1 parent 8ebee3d commit 127796e

4 files changed

Lines changed: 17 additions & 17 deletions

File tree

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: tests
1+
name: pals
22

33
on:
44
push:
@@ -7,15 +7,15 @@ on:
77
pull_request:
88

99
concurrency:
10-
group: ${{ github.ref }}-${{ github.head_ref }}-local-examples
10+
group: ${{ github.ref }}-${{ github.head_ref }}-examples
1111
cancel-in-progress: true
1212

1313
permissions:
1414
contents: read # access to check out code and install dependencies
1515

1616
jobs:
17-
local-examples:
18-
name: local examples
17+
examples:
18+
name: examples
1919
runs-on: ubuntu-latest
2020
strategy:
2121
matrix:
@@ -30,6 +30,6 @@ jobs:
3030
run: |
3131
python -m pip install --upgrade pip
3232
pip install ".[test]"
33-
- name: Run local examples
33+
- name: Run examples
3434
run: |
3535
python examples/fodo.py
Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: tests
1+
name: pals
22

33
on:
44
push:
@@ -7,22 +7,22 @@ on:
77
pull_request:
88

99
concurrency:
10-
group: ${{ github.ref }}-${{ github.head_ref }}-upstream-examples
10+
group: ${{ github.ref }}-${{ github.head_ref }}-standard-examples
1111
cancel-in-progress: true
1212

1313
permissions:
1414
contents: read # access to check out code and install dependencies
1515

1616
jobs:
17-
upstream-examples:
18-
name: upstream examples
17+
standard-examples:
18+
name: standard examples
1919
runs-on: ubuntu-latest
2020
strategy:
2121
matrix:
2222
python-version: ["3.11", "3.12", "3.13", "3.14"]
2323
steps:
2424
- uses: actions/checkout@v6
25-
- name: Checkout upstream PALS repo
25+
- name: Checkout PALS repository
2626
uses: actions/checkout@v6
2727
with:
2828
repository: pals-project/pals
@@ -38,8 +38,8 @@ jobs:
3838
run: |
3939
python -m pip install --upgrade pip
4040
pip install ".[test]"
41-
- name: Run upstream examples
41+
- name: Run standard examples
4242
run: |
4343
for file in pals_temp/examples/*.pals.yaml; do
44-
python tests/validate_upstream_examples.py --path "${file}"
44+
python tests/validate_standard_examples.py --path "${file}"
4545
done

.github/workflows/unit_tests.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: tests
1+
name: pals
22

33
on:
44
push:
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
"""Utility script to validate upstream PALS example files.
1+
"""Utility script to validate standard PALS example files.
22
33
This script is not run by pytest and is intended to be used as a standalone script.
44
Run it from the repository root like:
55
6-
python tests/validate_upstream_examples.py --path /path/to/example.pals.yaml
6+
python tests/validate_standard_examples.py --path /path/to/example.pals.yaml
77
8-
Before running, download the desired upstream PALS example files from pals-project/pals/examples.
8+
Before running, download the desired standard PALS example files from pals-project/pals/examples.
99
"""
1010

1111
import argparse
@@ -30,7 +30,7 @@ def main():
3030
example_file = args.path
3131
# Parse and validate YAML data from file
3232
lattice = load(example_file)
33-
# The following assertions are based on the upstream PALS example file
33+
# The following assertions are based on the standard PALS example file
3434
# fodo.pals.yaml from pals-project/pals/examples
3535
assert isinstance(lattice.facility[0], Drift)
3636
assert lattice.facility[0].name == "drift1"

0 commit comments

Comments
 (0)