feat: add readme
This commit is contained in:
parent
25392b8951
commit
e50e1e1e24
2 changed files with 25 additions and 2 deletions
23
README.md
Normal file
23
README.md
Normal file
|
@ -0,0 +1,23 @@
|
||||||
|
# Kaniko Action
|
||||||
|
|
||||||
|
Build OCI images using Kaniko, with the Dockerfile contents provided directly as an action input.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
jobs:
|
||||||
|
cowsay:
|
||||||
|
runs-on: docker
|
||||||
|
steps:
|
||||||
|
- uses: https://git.kabelsalat.ch/s3lph/forgejo-kaniko-action@v1
|
||||||
|
with:
|
||||||
|
dockerfile: |
|
||||||
|
FROM debian:latest
|
||||||
|
RUN apt update && apt install --yes cowsay
|
||||||
|
image: docker.example.org/example/cowsay:latest
|
||||||
|
registry: docker.example.org
|
||||||
|
username: ${{ secrets.REGISTRY_USERNAME }}
|
||||||
|
password: ${{ secrets.REGISTRY_PASSWORD }}
|
||||||
|
```
|
|
@ -14,10 +14,10 @@ inputs:
|
||||||
required: true
|
required: true
|
||||||
username:
|
username:
|
||||||
description: Username for the container registry
|
description: Username for the container registry
|
||||||
required: false
|
required: true
|
||||||
password:
|
password:
|
||||||
description: Password for the container registry
|
description: Password for the container registry
|
||||||
required: false
|
required: true
|
||||||
runs:
|
runs:
|
||||||
using: docker
|
using: docker
|
||||||
image: docker://gcr.io/kaniko-project/executor:debug
|
image: docker://gcr.io/kaniko-project/executor:debug
|
||||||
|
|
Loading…
Reference in a new issue