diff --git a/README.md b/README.md index ab98caf..91661ef 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# buildah +# buildah-action Buildah is a GitHub Action for building OCI-compatible (Docker- and Kubernetes-compatible) images quickly and easily. @@ -6,3 +6,94 @@ Buildah action works only on Linux distributions, and it is not supported on Win Note that GitHub's [Ubuntu Environments](https://github.com/actions/virtual-environments#available-environments) (ubuntu-20.04 and ubuntu-18.04) come with buildah 1.17.0 installed. So, if you are not using those Ubuntu environments you need to make sure to install buildah tool in an early step. +## Action Inputs + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Action inputDescription
new-image-name(Required) 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.
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
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
port(Required) The port to expose when running the container.
working-dir(Optional) 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
+ +## Examples + +``` +name: CI +on: [push] + +jobs: + build: + name: Build image + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v2 + + - name: Maven + run: | + cd ${GITHUB_WORKSPACE} + mvn package + - name: Build Action + uses: redhat-actions/buildah-action@0.0.1 + with: + new-image-name: petclinic + 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. + + diff --git a/action.yml b/action.yml index ea00ff3..ab394b0 100644 --- a/action.yml +++ b/action.yml @@ -1,6 +1,6 @@ -name: 'Lucas Test Build Action' +name: 'Buildah Action' description: 'This action allows you to build an image from your app' -author: 'Luca' +author: 'Red Hat' branding: icon: circle color: red @@ -19,7 +19,7 @@ inputs: required: true port: description: 'Port' - required: false + required: true working-dir: description: 'Working directory' required: false diff --git a/package.json b/package.json index b208cff..240cee6 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "buildah-action", "version": "0.0.1", - "description": "", + "description": "Action for building OCI-compatible images using buildah", "main": "index.js", "scripts": { "compile": "tsc -p .", diff --git a/src/buildah.ts b/src/buildah.ts index cd53878..f4ebc30 100644 --- a/src/buildah.ts +++ b/src/buildah.ts @@ -103,8 +103,8 @@ export class BuildahCli implements Buildah { }; const exitCode = await exec.exec(this.executable, args, options); if (exitCode === 1) { - return Promise.resolve({ succeeded: false, error: error }); + return Promise.resolve({ succeeded: false, error }); } - return Promise.resolve({ succeeded: true, output: output }); + return Promise.resolve({ succeeded: true, output }); } } \ No newline at end of file