diff --git a/README.md b/README.md index ceb1ae0..f8e5aca 100644 --- a/README.md +++ b/README.md @@ -75,6 +75,17 @@ Some extra options can be passed to the `docker-compose down` command using the # # Default: ${{ github.workspace }} cwd: "" + + # Description: Compose version to use. If null (default), it will use the current + # installed version. If "latest", it will install the latest version. + # + compose-version: "" + + # Description: The GitHub token used to create an authenticated client (to fetch + # the latest version of docker-compose). + # + # Default: ${{ github.token }} + github-token: "" ``` @@ -83,14 +94,16 @@ Some extra options can be passed to the `docker-compose down` command using the -| **Input** | **Description** | **Default** | **Required** | -| -------------------------- | -------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | ------------ | -| 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** | -| down-flags | Additional options to pass to docker-compose down command. | | **false** | -| compose-flags | Additional options to pass to docker-compose command. | | **false** | -| cwd | Current working directory | ${{ github.workspace }} | **false** | +| **Input** | **Description** | **Default** | **Required** | +| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------ | ------------ | +| 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** | +| down-flags | Additional options to pass to docker-compose down command. | | **false** | +| compose-flags | Additional options to pass to docker-compose command. | | **false** | +| cwd | Current working directory | ${{ github.workspace }} | **false** | +| compose-version | Compose version to use.
If null (default), it will use the current installed version.
If "latest", it will install the latest version. | | **false** | +| github-token | The GitHub token used to create an authenticated client (to fetch the latest version of docker-compose). | ${{ github.token }} | **false** |