Skip to content

Commit

Permalink
Document how to enable parallel step exec for all steps (#3605)
Browse files Browse the repository at this point in the history
Document how depends_on work in more details

---------

Co-authored-by: qwerty287 <[email protected]>
Co-authored-by: Anbraten <[email protected]>
  • Loading branch information
3 people authored Apr 10, 2024
1 parent b0c9dfd commit 399bc5b
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 2 deletions.
16 changes: 15 additions & 1 deletion docs/docs/20-usage/20-workflow-syntax.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,8 @@ git commit -m "updated README [CI SKIP]"

## 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.

```diff
Expand Down Expand Up @@ -484,6 +485,19 @@ Normally steps of a workflow are executed serially in the order in which they ar
- 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`

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.
Expand Down
16 changes: 15 additions & 1 deletion docs/versioned_docs/version-2.4/20-usage/20-workflow-syntax.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,8 @@ git commit -m "updated README [CI SKIP]"

## 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.

```diff
Expand Down Expand Up @@ -478,6 +479,19 @@ Normally steps of a workflow are executed serially in the order in which they ar
- 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`

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.
Expand Down

0 comments on commit 399bc5b

Please sign in to comment.