diff --git a/README.md b/README.md index 8d14ec3..d075521 100644 --- a/README.md +++ b/README.md @@ -15,48 +15,103 @@ Note that GitHub's [Ubuntu Environments](https://github.com/actions/virtual-envi
Action input | +input | +Required | Description | |
---|---|---|---|---|
new-image-name | -(Required) Name to give to the image that will be eventually created. | +image | +Yes | +Name to give to the image that will be eventually created. |
base-name | -(Optional) The base image to use to create the initial container. If not specified, the action will try to pick one automatically. Only Java language is supported at this time. | +No | +The base image to use to create the initial container. If not specified, the action will try to pick one automatically. (N.B: At this time the action is only able to auto select Java base image) | +|
dockerfiles | +No | +The list of Dockerfile paths to perform a build using docker instructions. This is a multiline input to add multiple values. | +||
context | +No | +The path of the directory to use as context (default: .) | ||
content | -(Required) The content to copy inside the container to create the final image. This is a multiline input to allow you to copy more than one file/directory. For example - content: | target/spring-petclinic-2.3.0.BUILD-SNAPSHOT.jar |
+ No | +The content to copy inside the container to create the final image. This is a multiline input to allow you to copy more than one file/directory. For example - content: | target/spring-petclinic-2.3.0.BUILD-SNAPSHOT.jar |
|
entrypoint | -(Required) The entry point to set for the container. This is a multiline input to add multiple values. For example - entrypoint: | java -jar spring-petclinic-2.3.0.BUILD-SNAPSHOT.jar |
+ No | +The entry point to set for the container. This is a multiline input to add multiple values. For example - entrypoint: | java -jar spring-petclinic-2.3.0.BUILD-SNAPSHOT.jar |
|
port | -(Required) The port to expose when running the container. | +No | +The port to expose when running the container. | |
working-dir | -(Optional) The working directory to use within the container. | +No | +The working directory to use within the container. | |
envs | -(Optional) The environment variables to be set when running the container. This is a multiline input to add multiple environment variables.For example - envs: | GOPATH=/root/buildah |
+ No | +The environment variables to be set when running the container. This is a multiline input to add multiple environment variables.For example - envs: | GOPATH=/root/buildah |