Mention backend_options in workflow syntax docs (#5096)

Co-authored-by: Robert Kaussow <xoxys@rknet.org>
This commit is contained in:
Oto Šťáva 2025-04-16 14:06:19 +02:00 committed by GitHub
parent 131d4afd1d
commit e1748606e0
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 18 additions and 0 deletions

View file

@ -510,6 +510,15 @@ For more details check the [service docs](./60-services.md#detachment).
Using `directory`, you can set a subdirectory of your repository or an absolute path inside the Docker container in which your commands will run.
### `backend_options`
With `backend_options` you can define options that are specific to the respective backend that is used to execute the steps. For example, you can specify the user and/or group used in a Docker container or you can specify the service account for Kubernetes.
Further details can be found in the documentation of the used backend:
- [Docker](../30-administration/10-configuration/11-backends/10-docker.md#step-specific-configuration)
- [Kubernetes](../30-administration/10-configuration/11-backends/20-kubernetes.md#step-specific-configuration)
## `services`
Woodpecker can provide service containers. They can for example be used to run databases or cache containers during the execution of workflow.

View file

@ -510,6 +510,15 @@ For more details check the [service docs](./60-services.md#detachment).
Using `directory`, you can set a subdirectory of your repository or an absolute path inside the Docker container in which your commands will run.
### `backend_options`
With `backend_options` you can define options that are specific to the respective backend that is used to execute the steps. For example, you can specify the user and/or group used in a Docker container or you can specify the service account for Kubernetes.
Further details can be found in the documentation of the used backend:
- [Docker](../30-administration/10-configuration/11-backends/10-docker.md#step-specific-configuration)
- [Kubernetes](../30-administration/10-configuration/11-backends/20-kubernetes.md#step-specific-configuration)
## `services`
Woodpecker can provide service containers. They can for example be used to run databases or cache containers during the execution of workflow.