github/woodpecker
1
0
Fork 0
mirror of https://github.com/woodpecker-ci/woodpecker.git synced 2025-09-01 22:59:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add depends_on to pipeline syntax docs (#1104)

Browse Source
This commit is contained in:
Anbraten
2022-08-14 17:32:01 +02:00
committed by GitHub
parent 991fcf7412
commit 446585ef1d
1 changed files with 9 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/docs/20-usage/20-pipeline-syntax.md
View File

@@ -21,12 +21,12 @@ pipeline:
In the above example we define two pipeline steps, `frontend` and `backend`. The names of these steps are completely arbitrary. In the above example we define two pipeline steps, `frontend` and `backend`. The names of these steps are completely arbitrary.
## Global Pipeline Conditionals ## Global Pipeline Conditionals
Woodpecker gives the ability to skip whole pipelines (not just steps) based on certain conditions. Woodpecker gives the ability to skip whole pipelines (not just steps) based on certain conditions.
### `branches` ### `branches`
Woodpecker can skip commits based on the target branch. If the branch matches the `branches:` block the pipeline is executed, otherwise it is skipped. Woodpecker can skip commits based on the target branch. If the branch matches the `branches:` block the pipeline is executed, otherwise it is skipped.
Example skipping a commit when the target branch is not master: Example skipping a commit when the target branch is not master:
@@ -244,7 +244,7 @@ go test
The above shell script is then executed as the container entrypoint. The below docker command is an (incomplete) example of how the script is executed: The above shell script is then executed as the container entrypoint. The below docker command is an (incomplete) example of how the script is executed:
``` ```bash
docker run --entrypoint=build.sh golang docker run --entrypoint=build.sh golang
``` ```
@@ -454,7 +454,7 @@ when:
ignore_message: "[ALL]" ignore_message: "[ALL]"
``` ```
** Hint: ** Passing a defined ignore-message like `[ALL]` inside the commit message will ignore all path conditions. **Hint:** Passing a defined ignore-message like `[ALL]` inside the commit message will ignore all path conditions.
### `group` - Parallel execution ### `group` - Parallel execution
@@ -506,7 +506,7 @@ For more details check the [services docs](/docs/usage/services/).
The workspace defines the shared volume and working directory shared by all pipeline steps. The default workspace matches the below pattern, based on your repository url. The workspace defines the shared volume and working directory shared by all pipeline steps. The default workspace matches the below pattern, based on your repository url.
``` ```txt
/drone/src/github.com/octocat/hello-world /drone/src/github.com/octocat/hello-world
``` ```
@@ -546,7 +546,7 @@ The base attribute defines a shared base volume available to all pipeline steps.
This would be equivalent to the following docker commands: This would be equivalent to the following docker commands:
``` ```bash
docker volume create my-named-volume docker volume create my-named-volume
docker run --volume=my-named-volume:/go golang:latest docker run --volume=my-named-volume:/go golang:latest
@@ -696,6 +696,10 @@ pipeline:
... ...
``` ```
## `depends_on`
Woodpecker supports to define multiple pipelines for a repository. Those pipelines will run independent from each other. To depend them on each other you can use the [`depends_on`](https://woodpecker-ci.org/docs/usage/multi-pipeline#flow-control) keyword.
## Privileged mode ## Privileged mode
Woodpecker gives the ability to configure privileged mode in the YAML. You can use this parameter to launch containers with escalated capabilities. Woodpecker gives the ability to configure privileged mode in the YAML. You can use this parameter to launch containers with escalated capabilities.