Skip to content

Commit

Permalink
Added documentation for new option (and corrected ordering
Browse files Browse the repository at this point in the history
  • Loading branch information
toote committed Nov 12, 2022
1 parent dd9f5e8 commit c309f54
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -614,14 +614,6 @@ The default is `on-error`.

If set to `2`, plugin will use `docker compose` to execute commands; otherwise it will default to version `1` using `docker-compose` instead.

## Developing

To run the tests:

```bash
docker-compose run --rm tests bats tests tests/v2
```

### `buildkit` (optional, build only, boolean)

Assuming you have a compatible docker installation and configuration in the agent, activating this option would setup the environment for the `docker-compose build` call to use BuildKit. Note that if you are using `cli-version` 2, you are already using buildkit by default.
Expand All @@ -632,6 +624,18 @@ You may want to also add `BUILDKIT_INLINE_CACHE=1` to your build arguments (`arg

When enabled, it will add the `--ssh` option to the build command. Note that it assumes you have a compatible docker installation and configuration in the agent (meaning you are using BuildKit and it is correctly setup).

### `secrets` (optional, build only, array of strings)

All elements in this array will be passed literally to the `build` command as parameters of the [`--secrets` option](https://docs.docker.com/engine/reference/commandline/buildx_build/#secret). Note that you must have BuildKit enabled for this option to have any effect and special `RUN` stanzas in your Dockerfile to actually make use of them.

## Developing

To run the tests:

```bash
docker-compose run --rm tests bats tests tests/v2
```

## License

MIT (see [LICENSE](LICENSE))

0 comments on commit c309f54

Please sign in to comment.