enfuse/Setup Docker
Setup Docker with layer caching, and login to container registry. see https://docs.docker.com/build/ci/github-actions/cache/#local-cache
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| GITHUB_TOKEN | GitHub token This input is passed to the step that uses the action [docker/login-action] and will be set in the [password] input This input is passed to the step that uses the action [actions/create-release] and will be set as the [env.GITHUB_TOKEN] You'll likely pass this from a repository secret For example: `secrets.GITHUB_TOKEN` which an org-level context variable setup for you by Github, or you can use your personal access token by setting it as a repository secret for use like this: `secrets.MY_PAT` | yes | — |
| APP_DIRECTORY | The root directory of the app being built. Useful for multi-app repos. For example: - Single-app repository: . - Multi-app repository: ./app-dir This input is passed to the action [docker/build-push-action] as the [context] input | yes | . |
| DOCKERFILE_LOCATION | The location of the Dockerfile, relative to the root of this repository. Note: Not relative to WORKING_DIRECTORY. If this is a multi-app repository, include the full path from the root of the repository to the subdirectory of the app. For example: - Single app repository: ./Dockerfile - Multi-app repository: ./app-dir/Dockerfile This input is passed to the step that uses the action [docker/build-push-action] and will be set in the [file] input | yes | ./Dockerfile |
| IMAGE_NAME | The name of the docker image. Do not include the tag. For example: - my_custom_docker_image The full image name to pull will be [ghcr.io/enfuse/my_custom_docker_image:latest] This input is passed to the step that uses the action [docker/build-push-action] and will be set in the [tags] input after being interpolated This input is passed to the step that uses the action [docker/metadata-action] and will be set in the [images] input after being interpolated as the image name | yes | — |
| GIT_TAG_PREFIX | This is the tag name that will trigger a release, and become the release version prefix. Do not include a version number (it will be extracted from the pushed tag) This input is used to detect a newly pushed tag so the version number can be extracted and used as the release version For example: - name_of_my_custom_app It's assumed that this will be the prefix of a pushed tag that looks like: [name_of_my_custom_app-1.0.3] This input is passed to the step with the id [extract_version] This input is passed to the step that uses the action [actions/create-release], and will be set in the [tag_name] and [release_name] inputs | yes | — |
| DOCKER_BUILD_ARGUMENTS | Build args for the dockerfile. These should be key-value pairs coupled with "=" and delimited with newlines (use the | character to make a multiline yaml string that preserves newlines) For example: | "HF_TOKEN=my-huggingface-token" "NVIDIA_API_KEY=my-nvidia-api-key" Note that the example above is passing secrets into the image, which isn't best-practice, but it's better than committing secrets as hardcoded values This input is passed to the step that uses the action [docker/build-push-action] and will be set in the [build-args] input | no | — |
| INTEGRATION_TEST_SCRIPT_PATH | Optionally run integration tests after building the image, but before pushing it. Omitting a path will skip this step The path should lead to a script that will run the integration tests The script must return an exit code when completed to indicate success/failure, so we only push the image if the tests pass | no | — |
| DOCKER_BUILD_NO_CACHE | Disable the use of cached layers when building the image | no | false |
Outputs
no outputs