Skip to content

Commit

Permalink
Merge pull request #124 from jnywong/document-tests-for-dockerfile
Browse files Browse the repository at this point in the history
Add warning for image-tests when using DockerFile
  • Loading branch information
yuvipanda authored May 27, 2024
2 parents 774bbb1 + a8c374c commit c26a270
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
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

0 comments on commit c26a270

Please sign in to comment.