Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add warning for image-tests when using DockerFile #124

Merged
merged 2 commits into from
May 27, 2024
Merged

Add warning for image-tests when using DockerFile #124

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0218628
Add warning for image-tests when using DockerFile
jnywong May 27, 2024
a8c374c
Copy file into REPO_DIR
yuvipanda May 27, 2024
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
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,9 @@ run any Jupyter Notebooks as tests.

This **works with any Jupyter kernel**. This action will use the Jupyter kernel defined in any notebook you put in `image-tests/`. This can be used to execute and test notebooks from any language.

> [!WARNING]
> If you are using a Dockerfile to configure your environment, then include `COPY --chown=${NB_USER}:${NB_USER} image-tests ${REPO_DIR}/image-tests` in your Dockerfile to ensure the correct ownership of this folder within the image.

To use automatic image testing, follow these steps:

1. Create a directory named `image-tests/` in your GitHub repository.
Expand Down