mirrors/woodpecker
1
0
Fork 0
mirror of https://github.com/woodpecker-ci/woodpecker.git synced 2024-11-29 13:21:10 +00:00
Code Issues Projects Releases Wiki Activity

Document how to enable parallel step exec for all steps (#3605)

Browse source 
Document how depends_on work in more details

---------

Co-authored-by: qwerty287 <80460567+qwerty287@users.noreply.github.com>
Co-authored-by: Anbraten <6918444+anbraten@users.noreply.github.com>
This commit is contained in:
6543 2024-04-10 12:31:42 +02:00 committed by GitHub
parent b0c9dfd2cf
commit 399bc5bf1b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 30 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
docs/docs/20-usage/20-workflow-syntax.md
View file

@ -50,7 +50,8 @@ git commit -m "updated README [CI SKIP]"
## Steps ## Steps
Every step of your workflow executes commands inside a specified container. The defined commands are executed serially. Every step of your workflow executes commands inside a specified container.<br>
The defined steps are executed in sequence by default, if they should run in parallel you can use [`depends_on`](./20-workflow-syntax.md#depends_on).<br>
The associated commit is checked out with git to a workspace which is mounted to every step of the workflow as the working directory. The associated commit is checked out with git to a workspace which is mounted to every step of the workflow as the working directory.
```diff ```diff
@ -484,6 +485,19 @@ Normally steps of a workflow are executed serially in the order in which they ar
- go test - go test
``` ```
:::note
You can define a step to start immediately without dependencies by adding an empty `depends_on: []`. By setting `depends_on` on a single step all other steps will be immediately executed as well if no further dependencies are specified.
```yaml
steps:
- name: check code format
image: mstruebing/editorconfig-checker
depends_on: [] # enable parallel steps
...
```
:::
### `volumes` ### `volumes`
Woodpecker gives the ability to define Docker volumes in the YAML. You can use this parameter to mount files or folders on the host machine into your containers. Woodpecker gives the ability to define Docker volumes in the YAML. You can use this parameter to mount files or folders on the host machine into your containers.

16
docs/versioned_docs/version-2.4/20-usage/20-workflow-syntax.md
View file

@ -50,7 +50,8 @@ git commit -m "updated README [CI SKIP]"
## Steps ## Steps
Every step of your workflow executes commands inside a specified container. The defined commands are executed serially. Every step of your workflow executes commands inside a specified container.<br>
The defined steps are executed in sequence by default, if they should run in parallel you can use [`depends_on`](./20-workflow-syntax.md#depends_on).<br>
The associated commit is checked out with git to a workspace which is mounted to every step of the workflow as the working directory. The associated commit is checked out with git to a workspace which is mounted to every step of the workflow as the working directory.
```diff ```diff
@ -478,6 +479,19 @@ Normally steps of a workflow are executed serially in the order in which they ar
- go test - go test
``` ```
:::note
You can define a step to start immediately without dependencies by adding an empty `depends_on: []`. By setting `depends_on` on a single step all other steps will be immediately executed as well if no further dependencies are specified.
```yaml
steps:
- name: check code format
image: mstruebing/editorconfig-checker
depends_on: [] # enable parallel steps
...
```
:::
### `volumes` ### `volumes`
Woodpecker gives the ability to define Docker volumes in the YAML. You can use this parameter to mount files or folders on the host machine into your containers. Woodpecker gives the ability to define Docker volumes in the YAML. You can use this parameter to mount files or folders on the host machine into your containers.