Small readme edit, fix ncc dependency

Signed-off-by: Tim Etchells <tetchell@redhat.com>
This commit is contained in:
Tim Etchells 2020-11-19 14:49:47 -05:00
parent 236b973ed2
commit 4373525da7
5 changed files with 18 additions and 7 deletions

View file

@ -1,5 +1,5 @@
# buildah # buildah
[![Verify Bundle](https://github.com/redhat-actions/buildah-action/workflows/Verify%20Bundle/badge.svg)](https://github.com/redhat-actions/buildah-action/actions?query=workflow%3A%22Verify+Bundle%22)
[![tag badge](https://img.shields.io/github/v/tag/redhat-actions/buildah-action?sort=semver)](https://github.com/redhat-actions/buildah-action/tags) [![tag badge](https://img.shields.io/github/v/tag/redhat-actions/buildah-action?sort=semver)](https://github.com/redhat-actions/buildah-action/tags)
[![license badge](https://img.shields.io/github/license/redhat-actions/buildah-action)](./LICENSE) [![license badge](https://img.shields.io/github/license/redhat-actions/buildah-action)](./LICENSE)
[![size badge](https://img.shields.io/github/size/redhat-actions/buildah-action/dist/index.js)](./dist) [![size badge](https://img.shields.io/github/size/redhat-actions/buildah-action/dist/index.js)](./dist)
@ -45,7 +45,7 @@ Note that GitHub's [Ubuntu Environments](https://github.com/actions/virtual-envi
<tr> <tr>
<td>dockerfiles</td> <td>dockerfiles</td>
<td>No</td> <td>No</td>
<td>The list of Dockerfile paths to perform a build using docker instructions. This is a multiline input if you wish to add multiple Dockerfiles. <td>The list of Dockerfile paths to perform a build using docker instructions. This is a multiline input to allow multiple Dockerfiles.
</td> </td>
</tr> </tr>
@ -68,8 +68,11 @@ Note that GitHub's [Ubuntu Environments](https://github.com/actions/virtual-envi
<tr> <tr>
<td>entrypoint</td> <td>entrypoint</td>
<td>No</td> <td>No</td>
<td>The entry point to set for the container. Can split arguments across multiple lines if desired. <td>The entry point to set for the container. This is a multiline input; split arguments across lines.
<pre>entrypoint: java -jar spring-petclinic-2.3.0.BUILD-SNAPSHOT.jar</pre> <pre>entrypoint: |
java
-jar
spring-petclinic-2.3.0.BUILD-SNAPSHOT.jar</pre>
</td> </td>
</tr> </tr>
@ -139,7 +142,8 @@ Do not set `dockerfiles` if you are doing a build from scratch, or a docker buil
- `content` to copy into the new image - `content` to copy into the new image
- In a Dockerfile, this would be `COPY` directives. - In a Dockerfile, this would be `COPY` directives.
- `entrypoint` so the container knows what command to run. - `entrypoint` so the container knows what command to run.
- All other optional configuration inputs. - 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: Example of building a Spring Boot Java app image:
```yaml ```yaml

2
dist/index.js vendored

File diff suppressed because one or more lines are too long

2
dist/index.js.map vendored

File diff suppressed because one or more lines are too long

6
package-lock.json generated
View file

@ -28,6 +28,12 @@
"integrity": "sha512-Wgdl27uw/jUYUFyajUGKSjDNGxmJrZi9sjeG6UJImgUtKbJoO9aldx+1XODN1EpNDX9DirvbvHHmTsNlb8GwMA==", "integrity": "sha512-Wgdl27uw/jUYUFyajUGKSjDNGxmJrZi9sjeG6UJImgUtKbJoO9aldx+1XODN1EpNDX9DirvbvHHmTsNlb8GwMA==",
"dev": true "dev": true
}, },
"@vercel/ncc": {
"version": "0.25.1",
"resolved": "https://registry.npmjs.org/@vercel/ncc/-/ncc-0.25.1.tgz",
"integrity": "sha512-dGecC5+1wLof1MQpey4+6i2KZv4Sfs6WfXkl9KfO32GED4ZPiKxRfvtGPjbjZv0IbqMl6CxtcV1RotXYfd5SSA==",
"dev": true
},
"argparse": { "argparse": {
"version": "1.0.10", "version": "1.0.10",
"resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz",

View file

@ -19,6 +19,7 @@
}, },
"devDependencies": { "devDependencies": {
"@types/node": "^12", "@types/node": "^12",
"@vercel/ncc": "^0.25.1",
"typescript": "^4.0.5" "typescript": "^4.0.5"
} }
} }