| Input |
Required |
Description |
| image |
Yes |
Name to give the output image. |
| tag |
No |
Tag to give to the output image.
Default: latest
|
| base-image |
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 allow multiple Dockerfiles.
|
| context |
No |
Path to directory to use as the build context.
Default: . |
| build-args |
No |
Build arguments to pass to the Docker build using --build-arg, if using a Dockerfile that requires ARGs.
Uses the form arg_name=arg_value, and separate arguments with newlines. |
| content |
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.
content: |
target/spring-petclinic-2.3.0.BUILD-SNAPSHOT.jar
|
| entrypoint |
No |
The entry point to set for the container. This is a multiline input; split arguments across lines.
entrypoint: |
java
-jar
spring-petclinic-2.3.0.BUILD-SNAPSHOT.jar
|
| port |
No |
The port to expose when running the container. |
| workdir |
No |
The working directory to use within the container. |
| envs |
No |
The environment variables to be set when running the container. This is a multiline input to add multiple environment variables.
envs: |
GOPATH=/root/buildah/go
|
## Build Types
You can configure the `buildah` action to build your image using one or more Dockerfiles, or from scratch.
### Building using Docker
If you have been using Docker and have an existing Dockerfile, `buildah` can reuse your dockerfile.
In this case the inputs needed are `image` and `dockerfiles`. `tag` is also recommended. If your Dockerfile requires ARGs, these can be passed using `build-arg`.
```yaml
name: Build Image using Dockerfile
on: [push]
jobs:
build:
name: Build image
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Buildah Action
uses: redhat-actions/buildah-build@v1
with:
image: my-new-image
tag: v1
dockerfiles: |
./Dockerfile
build-args: |
some_arg=some_value
```
### Building from scratch
Building from scratch requires more inputs, that would normally be specified in the Dockerfile.
Do not set `dockerfiles` if you are doing a build from scratch, or a docker build will be performed, and the other inputs will be ignored.
- An output `image` name and usually a `tag`.
- `base-image`
- In a Dockerfile, this would be the `FROM` directive.
- `content` to copy into the new image
- In a Dockerfile, this would be `COPY` directives.
- `entrypoint` so the container knows what command to run.
- In a Dockerfile, this would be the `ENTRYPOINT`.
- All other optional configuration inputs, such as `port`, `envs`, and `workdir`.
Example of building a Spring Boot Java app image:
```yaml
name: Build Image
on: [push]
jobs:
build-image:
name: Build image
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- run: mvn package
- name: Build Image
uses: redhat-actions/buildah-build@v1
with:
base-image: docker.io/fabric8/java-alpine-openjdk11-jre
image: my-new-image
tag: v1
content: |
target/spring-petclinic-2.3.0.BUILD-SNAPSHOT.jar
entrypoint: java -jar spring-petclinic-2.3.0.BUILD-SNAPSHOT.jar
port: 8080
```
## Contributing
This is an open source project open to anyone. This project welcomes contributions and suggestions!
## Feedback & Questions
If you discover an issue please file a bug in [GitHub issues](https://github.com/redhat-actions/buildah/issues) and we will fix it as soon as possible.
## License
MIT, See [LICENSE](https://github.com/redhat-actions/buildah/blob/main/LICENSE.md) for more information.