Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
whoan committed Oct 15, 2023
1 parent 918ace7 commit 806baa9
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,6 @@ or

- **stages_image_name**: Set custom name for stages. Useful if using a job matrix (default: `$image_name-stages)`.

- **build_extra_args**: Extra params for `docker build` (e.g. `"--build-arg=hello=world"`).
> :star2: New in v5.11.0: If you need extra args with newlines or spaces, use json format like this:
`build_extra_args: '{"--build-arg": "myarg=Hello\nWorld"}'`

> :star2: If you need multiple args with same key, use an array as the value of the key like this:
`build_extra_args: '{"--build-arg": ["foo=bar", "one=two"]}'`

- **push_image_and_stages**: Test a command before pushing. Use `false` to not push at all (default: `true`).

This input also supports 2 special values, which are useful if your workflow can be triggered by different events:
Expand All @@ -74,6 +67,13 @@ or

- **dockerfile**: Dockerfile filename path (default: `"$context"/Dockerfile`).

- **build_extra_args**: Extra params for `docker build` (e.g. `"--build-arg=hello=world"`).
> :star2: New in v5.11.0: If you need extra args with newlines or spaces, use json format like this:
`build_extra_args: '{"--build-arg": "myarg=Hello\nWorld"}'`

> :star2: If you need multiple args with same key, use an array as the value of the key like this:
`build_extra_args: '{"--build-arg": ["foo=bar", "one=two"]}'`

## Outputs

- **FULL_IMAGE_NAME**: Full name of the Docker Image with the Registry (if provided) and Namespace included.
Expand Down

0 comments on commit 806baa9

Please sign in to comment.