Add docs to the new build args
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful

This commit is contained in:
PapaTutuWawa 2023-10-08 16:06:59 +02:00
parent 8d04efc34a
commit bd3ca935de

22
docs.md
View File

@ -109,7 +109,7 @@ If it's not a tag event, and no default branch, automated tags are skipped.
| `default_tag` | `latest` | overrides the default tag name used when generating with `auto_tag` enabled | `default_tag` | `latest` | overrides the default tag name used when generating with `auto_tag` enabled
| `label`/`labels` | *none* | sets labels to use for the image in format `<name>=<value>` | `label`/`labels` | *none* | sets labels to use for the image in format `<name>=<value>`
| `default_labels`/`auto_labels` | `true` | sets docker image labels based on git information | `default_labels`/`auto_labels` | `true` | sets docker image labels based on git information
| `build_args` | *none* | sets custom build arguments for the build | `build_args` | *none* | sets custom build arguments for the build. Key-Value pairs
| `build_args_from_env` | *none* | forwards environment variables as custom arguments to the build | `build_args_from_env` | *none* | forwards environment variables as custom arguments to the build
| `quiet` | `false` | enables suppression of the build output | `quiet` | `false` | enables suppression of the build output
| `target` | *none* | sets the build target to use | `target` | *none* | sets the build target to use
@ -124,6 +124,26 @@ If it's not a tag event, and no default branch, automated tags are skipped.
| `logins` | *none* | option to log into multiple registries | `logins` | *none* | option to log into multiple registries
| `env_file` | *none* | load env vars from specified file | `env_file` | *none* | load env vars from specified file
## Build-Args example
```yaml
settings:
repo: a6543/tmp,codeberg.org/6543/tmp
tag: demo
build_args:
value1: hallo
value2: welt
logins:
- registry: https://index.docker.io/v1/
username: a6543
password:
from_secret: docker_token
- registry: https://codeberg.org
username: "6543"
password:
from_secret: cb_token
```
## Multi registry push example ## Multi registry push example
Only supported with `woodpecker >= 1.0.0` (next-da997fa3). Only supported with `woodpecker >= 1.0.0` (next-da997fa3).