Skip to content

Commit

Permalink
Add breaking note for command: removal (#2056)
Browse files Browse the repository at this point in the history
close  #2054

as we missed at #1032 that it was mentioned at one point in the docs and
so it was a breaking change
  • Loading branch information
6543 authored Jul 29, 2023
1 parent c96fc3f commit 960a52b
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 2 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
* Access repos by their IDs (#1691)
* Drop "coding" support (#1644)
* Add queue details UI for admins (#1632)
* Remove `command:` from steps (#1032)
* Remove old `build` API routes (#1283)
* Let single line command be a single command (#1009)
* Drop deprecated environment vars (#920)
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/20-usage/20-pipeline-syntax.md
Original file line number Diff line number Diff line change
Expand Up @@ -908,6 +908,6 @@ Woodpecker gives the ability to configure privileged mode in the YAML. You can u
services:
docker:
image: docker:dind
command: [ "--storage-driver=vfs", "--tls=false" ]
commands: dockerd-entrypoint.sh --storage-driver=vfs --tls=false
+ privileged: true
```
3 changes: 3 additions & 0 deletions docs/docs/91-migrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ Some versions need some changes to the server configuration or the pipeline conf
- To find the id of orgs use the `/api/orgs/lookup/{org_full_name}` endpoint.
- The UI urls for a organization changed from `/org/{owner}/...` to `/orgs/{org-id}/...`. You will be redirected automatically when using the old url.
- The woodpecker-go api-client is now using the `org-id` instead of `org name` for all functions
- The `command:` field has been removed from steps. If you were using it, please check if the entrypoint of the image you used is a shell.
- If it is a shell, simply rename `command:` to `commands:`.
- If it's not, you need to prepend the entrypoint before and also rename it (e.g., `commands: <entrypoint> <cmd>`).

## 0.15.0

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -908,6 +908,6 @@ Woodpecker gives the ability to configure privileged mode in the YAML. You can u
services:
docker:
image: docker:dind
command: [ "--storage-driver=vfs", "--tls=false" ]
commands: dockerd-entrypoint.sh --storage-driver=vfs --tls=false
+ privileged: true
```
3 changes: 3 additions & 0 deletions docs/versioned_docs/version-1.0/91-migrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ No breaking changes
- To find the id of orgs use the `/api/orgs/lookup/{org_full_name}` endpoint.
- The UI urls for a organization changed from `/org/{owner}/...` to `/orgs/{org-id}/...`. You will be redirected automatically when using the old url.
- The woodpecker-go api-client is now using the `org-id` instead of `org name` for all functions
- The `command:` field has been removed from steps. If you were using it, please check if the entrypoint of the image you used is a shell.
- If it is a shell, simply rename `command:` to `commands:`.
- If it's not, you need to prepend the entrypoint before and also rename it (e.g., `commands: <entrypoint> <cmd>`).

## 0.15.0

Expand Down

0 comments on commit 960a52b

Please sign in to comment.