Skip to content

Commit 3665e55

Browse files
committed
Update README.md to clarify Nexus-ready notebook syncing and add Manual Notebook CI details
1 parent 1c4dca2 commit 3665e55

File tree

2 files changed

+22
-5
lines changed

2 files changed

+22
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -92,13 +92,14 @@ Before submitting a pull request, please check whether an existing issue or disc
9292

9393
## Syncing Notebooks to the Roman Research Nexus
9494

95-
Syncing notebooks from canonical sources in this repo with the STScI `roman_notebooks` repository is an automated process handled by GitHub Actions when a pull request is merged.
95+
Syncing Nexus-ready notebook artifacts is an automated process handled by GitHub Actions when a pull request is merged.
9696

9797
The workflow will:
98-
- Copy the notebook to the appropriate location in the `roman_notebooks` repository.
99-
- Validate that relative paths in the notebook are correct for the RRN structure.
100-
- Correct style and contents to satisfy Nexus-specific requirements.
101-
- Copy any associated `requirements.txt` or `env.yml` files.
98+
- Rebuild Nexus-ready notebook artifacts into `RRN/build/` using `scripts/notebook_transformer.py` and `notebooks_manifest.yml`.
99+
- Export those artifacts into the dedicated `rges-pit/nexus-notebooks` repository via the `RRN/export_submodule/` submodule.
100+
- Force-push the artifact branch (`main`) because the destination repository is treated as export-only.
101+
102+
For a manual, on-demand execution check of the build artifacts, see `RRN/README.md` (Manual Notebook CI).
102103

103104
## Notes on Using and Contributing from Colab
104105

RRN/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,19 @@
99
Notebooks in this directory are managed by GitHub workflow `.github/workflows/publish.yml`.
1010

1111
See notebooks_manifest for canonical source file: `source_path:`.
12+
13+
### Manual Notebook CI (Build Artifacts)
14+
15+
This repository includes a manual (workflow-dispatch) CI job that rebuilds the
16+
Nexus-ready notebook artifacts in `RRN/build/` and then executes them.
17+
18+
- Workflow: `.github/workflows/manual-notebook-ci.yml`
19+
- Profiles:
20+
- **fast**: skips cells tagged `slow` or `ci-skip`
21+
- **full**: skips only `ci-skip`
22+
23+
Notes:
24+
- The workflow deletes `RRN/build/` before rebuilding to avoid executing stale
25+
notebooks (for example, notebooks marked `nexus_support: false` in the
26+
manifest).
27+
- Cell tags can be edited in the notebook UI (cell metadata tags).

0 commit comments

Comments
 (0)