actions-marketplace-validations/repo2docker Action

Creates a docker image of your repository to view the collection of notebooks

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
DOCKER_USERNAMEDocker registry username. If not supplied, credentials must be setup ahead of time.
DOCKER_PASSWORDDocker registry password. If not supplied, credentials must be setup ahead of time.no
DOCKER_REGISTRYdomain name of the docker registry. If not supplied, this defaults to registry.hub.docker.com.
IMAGE_NAMEname of the image. Example - myusername/myContainer. If not supplied, this defaults to $DOCKER_USERNAME/$GITHUB_REPOSITORY_NAME or $GITHUB_ACTOR/$GITHUB_REPOSITORY_NAME.
NOTEBOOK_USERusername of the primary user in the image
REPO_DIRpath inside the image where contents of the repositories are copied to
APPENDIX_FILEAppendix 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.
LATEST_TAG_OFFSetting this variable to any value will prevent your image from being tagged with `latest`, in additiona to the GitHub commit SHA. This is enabled by default.
ADDITIONAL_TAGAn optional string that specifies the name of an additional tag you would like to apply to the image. Images are already tagged with the relevant GitHub SHA.
NO_PUSHSetting this variable to any value will turn debug mode on. When debug mode is on, images will not be pushed to the registry. Furthermore, verbose logging will be enabled.
BINDER_CACHESetting this variable to any value will add the file binder/Dockerfile that references the docker image that was pushed to the registry by this Action. You cannot use this option if the parameter NO_PUSH is set. This is disabled by default.
COMMIT_MSGThe commit message associated with specifying the `BINDER_CACHE` flag.Update image tag
MYBINDERORG_TAGThis the Git branch, tag, or commit that you want mybinder.org to proactively build from your repo. This is useful if you wish to avoid startup time on mybinder.org. Your repository must be public for this work, as mybinder.org only works on public repositories.
PUBLIC_REGISTRY_CHECKSetting this variable to any value will validate that the image pushed to the registry is publicly visible.
NO_GIT_PUSHThis is a private variable that is used by the maintainers of this Action for debugging. Setting this value to true will prevent any changes from being saved to your repository.
REPO2DOCKER_EXTRA_ARGSExtra commandline arguments to be passed to repo2docker
FORCE_REPO2DOCKER_VERSIONForce 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
EXTRA_PIP_INSTALLExtra packages to install in the image before running repo
namedescription
IMAGE_SHA_NAMEThe name of the docker image, which is tagged with the SHA.