Skip to content

Commit dbee55f

Browse files
committed
Use PAT to clone private test-datasets submodule in CI.
Document the CHEMSPECTRA_TEST_FILES_PAT secret setup for maintainers.
1 parent 734b15c commit dbee55f

2 files changed

Lines changed: 33 additions & 0 deletions

File tree

.github/workflows/unit_test.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,20 @@ jobs:
99
- uses: actions/checkout@v5
1010
with:
1111
submodules: recursive
12+
# chem-spectra-test-files is private; use a PAT with repo read access,
13+
# or enable org-wide GITHUB_TOKEN access, or make the dataset repo public.
14+
token: ${{ secrets.CHEMSPECTRA_TEST_FILES_PAT != '' && secrets.CHEMSPECTRA_TEST_FILES_PAT || github.token }}
15+
- name: Verify test-datasets submodule
16+
run: |
17+
if [ ! -f test-datasets/catalog/datasets.json ]; then
18+
echo "::error::Submodule test-datasets is missing."
19+
echo "chem-spectra-test-files is a private repository."
20+
echo "Fix options:"
21+
echo " 1. Add repo secret CHEMSPECTRA_TEST_FILES_PAT (read access to ComPlat/chem-spectra-test-files)"
22+
echo " 2. Enable org setting: Actions may access other repositories in ComPlat"
23+
echo " 3. Make ComPlat/chem-spectra-test-files public"
24+
exit 1
25+
fi
1226
- uses: actions/setup-python@v6
1327
with:
1428
check-latest: true

INSTALL.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,3 +152,22 @@ gunicorn -w 4 -b 0.0.0.0:3007 server:app --daemon
152152
```sh
153153
python -m pytest
154154
```
155+
156+
### 3.1. CI configuration (maintainers)
157+
158+
The `test-datasets` submodule points to
159+
[ComPlat/chem-spectra-test-files](https://github.com/ComPlat/chem-spectra-test-files),
160+
which is currently **private**. GitHub Actions cannot clone it without credentials.
161+
162+
Choose one fix:
163+
164+
1. **Recommended for open test data:** make `chem-spectra-test-files` public.
165+
2. **Repository secret:** add `CHEMSPECTRA_TEST_FILES_PAT` on `chem-spectra-app`
166+
(Settings → Secrets and variables → Actions). Use a fine-grained PAT or classic
167+
PAT with read access to `ComPlat/chem-spectra-test-files`.
168+
3. **Organization setting:** in ComPlat org settings, allow GitHub Actions
169+
workflows to access other private repositories (then the default
170+
`GITHUB_TOKEN` may be sufficient).
171+
172+
The workflow validates that `test-datasets/catalog/datasets.json` exists after
173+
checkout and prints these instructions if the submodule failed to initialize.

0 commit comments

Comments
 (0)