notebooks: align notebook inclusion + testing with upstream repos
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 87
- Forks
- 59
- Avg merge
- 22h 56m
- Merged PRs (30d)
- 4
Description
Description
The rapidsai/notebooks image bundles sample notebooks from a few RAPIDS projects.
CI here tests them:
CI here often fails a few times a release with problems of the form "some notebook broke upstream and isn't tested in CI there but is here".
That problem should be engineered away.
Benefits of this work
- improved CI stability
- improved release confidence
- reduced maintenance burden
Acceptance Criteria
- there are 0 notebooks tested in this project's CI which aren't tested in the repo where they're developed
Approach
I can see a few differnent ways to do this, listing some ideas here:
- ensure all the notebooks are tested in the cuDF, cuML, cuGraph, etc. repos
- stop testing any notebooks here and accept them as-is
- stop bundling notebooks in these images at all (then
rapidsai/notebookswould become "rapidsai/base+ a jupyterlab setup) - somehow programatically align what's tested here with what's tested in the repos (like invoking a
test_notebooks.shscript directly from the repos or something)
Notes
N/A
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with .github/workflows/test-notebooks.yml around lines 93-94 and inspect how this repository selects and tests notebooks. Compare that set with the corresponding testing entry points in the RAPIDS repositories that develop them. Done means no notebook is tested here unless it is also tested in its development repository.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, github-actions, jupyter-notebook, shell
- Domain
- ci-cd, devops, testing-qa
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100