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..2360c16 100644 --- a/action.yml +++ b/action.yml @@ -40,7 +40,7 @@ runs: password: ${{ inputs.DOCKER_PASSWORD }} - name: Cache Docker layers - uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4 + uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684 # v4 with: path: /tmp/.buildx-cache key: ${{ runner.os }}-${{ inputs.name }}-${{ github.sha }}