repodynamics/BinderDocker
Creates a docker image of your repository to view the collection of notebooks
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stalelast commit Dec 10, 2024
- License
- MIT
Pinned Snippet
uses: repodynamics/binderdocker@e5e7d8b8c8ecec5696b48fc2d34ca3a53eb4131c # v0.1tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| image_name | Name of the image, i.e., `NAMESPACE/IMAGE_NAME` or `REGISTRY/NAMESPACE/IMAGE_NAME`. If `REGISTRY` is omitted, Docker assumes `docker.io`. Note that the tag must be omitted here. Examples: 'ghcr.io/RepoDynamics/BinderDocker' The name will be automatically lowercased, as Docker only allows lowercase image names. | yes | — |
| image_tags | Tag(s) of the image. Multiple tags must be separated by spaces. | yes | latest |
| image_user | username of the primary user in the image | yes | jovyan |
| image_dir | path inside the image where contents of the repositories are copied to | no | — |
| git_ref | Git ref (e.g., commit hash) to assign to the 'repo2docker.ref' image label. | yes | — |
| git_path | Path to the git repository to build. Defaults to current working directory. | no | "" |
| cache_image_names | Names of previous versions of this image to use as cache. Multiple names must be separated by spaces. In contrast to `image_name`, these names must include the tag. | no | "" |
| cache_image_tags | Tags of previous versions of this image to use as cache. Multiple tags must be separated by spaces. These are converted to full image names using `image_name` as the base name, and added to `cache_image_names`. | no | "" |
| repo2docker_args | Extra commandline arguments to be passed to repo2docker | no | — |
| repo2docker_version | Force a specific version of repo2docker to be installed. Either in the form of `repo2docker==<version>` for install from pypi, or `git+https://<github-url>@<commit-hash` for installing from a github repo / branch | no | — |
| dockerfile_append | Appendix of Dockerfile commands to run at the end of the build. Can be used to customize the resulting image after all standard build steps finish. | no | — |
| test_script | A bash script to run inside the container to test the built image. Example: ``` python3 -m pip install --no-cache -r image-tests/requirements.txt pytest image-tests/ ``` | no | — |
| push | Whether to push the image to the registry. Accepted values are 'true', 'True', '1', 'false', 'False', '0'. | no | false |
| verify_public | Verify whether the pushed image is publicly available. Options are: - error: Verify and raise an error if the image is not publicly available. - warning: Verify and create a warning annotation if the image is not publicly available. - false: Do not verify. Note that if any option other than 'false' is selected, the action will logout from docker. | no | false |
| docker_registry | Docker registry. | no | — |
| docker_username | Docker username. | no | — |
| docker_password | Docker password. | no | — |
Outputs
| name | description |
|---|---|
| image_names | Full names of all tagged docker images, as a JSON array string. |
| image_digest | SHA-256 hash digest of the image. This is only available when 'push' is set to true. |