diff --git a/README.md b/README.md new file mode 100644 index 0000000..6baf059 --- /dev/null +++ b/README.md @@ -0,0 +1,59 @@ +## Docker build + +### Description + +Builds a docker image + +### Inputs + +| name | description | required | default | +| --- | --- | --- | --- | +| `name` |

Directory name

| `true` | `""` | +| `REGISTRY_USERNAME` |

Registry username

| `true` | `""` | +| `REGISTRY_TOKEN` |

Registry token

| `true` | `""` | +| `DOCKER_USERNAME` |

Docker username

| `true` | `""` | +| `DOCKER_PASSWORD` |

Docker password

| `true` | `""` | + + +### Runs + +This action is a `composite` action. + +### Usage + +```yaml +- uses: ***PROJECT***@***VERSION*** + with: + name: + # Directory name + # + # Required: true + # Default: "" + + REGISTRY_USERNAME: + # Registry username + # + # Required: true + # Default: "" + + REGISTRY_TOKEN: + # Registry token + # + # Required: true + # Default: "" + + DOCKER_USERNAME: + # Docker username + # + # Required: true + # Default: "" + + DOCKER_PASSWORD: + # Docker password + # + # Required: true + # Default: "" +``` + + + diff --git a/action.yml b/action.yml index b4aaa5c..1d2a973 100644 --- a/action.yml +++ b/action.yml @@ -21,7 +21,7 @@ runs: using: "composite" steps: - name: Checkout - uses: https://git.kjan.de/actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4 + uses: https://git.kjan.de/actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 - name: Set up Docker Buildx uses: https://git.kjan.de/actions/setup-buildx-action@988b5a0280414f521da01fcc63a27aeeb4b104db # v3