diff --git a/README.md b/README.md index f9c6747..463a230 100644 --- a/README.md +++ b/README.md @@ -12,18 +12,14 @@ -Release%20by%20tag -Release%20by%20date -Commit -Open%20Issues -Downloads +Release%20by%20tagRelease%20by%20dateCommitOpen%20IssuesDownloads -This action runs your [docker compose](https://docs.docker.com/reference/compose-file/) file and clean up before action finished +This action runs your compose file(s) and clean up before action finished @@ -50,6 +46,10 @@ Some extra options can be passed to the `docker compose down` command using the ```yaml - uses: hoverkraft-tech/compose-action@v0.0.0 with: + # Description: Additional options to pass to `docker` command. + # + docker-flags: "" + # Description: Path to compose file(s). It can be a list of files. It can be # absolute or relative to the current working directory (cwd). # @@ -100,6 +100,7 @@ Some extra options can be passed to the `docker compose down` command using the | **Input** | **Description** | **Default** | **Required** | | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------ | ------------ | +| docker-flags | Additional options to pass to docker command. | | **false** | | compose-file | Path to compose file(s). It can be a list of files. It can be absolute or relative to the current working directory (cwd). | ./docker-compose.yml | **false** | | services | Services to perform docker compose up. | | **false** | | up-flags | Additional options to pass to docker compose up command. | | **false** |