diff --git a/docs/docs/20-usage/20-workflow-syntax.md b/docs/docs/20-usage/20-workflow-syntax.md index 7971876e7..9c5c21d95 100644 --- a/docs/docs/20-usage/20-workflow-syntax.md +++ b/docs/docs/20-usage/20-workflow-syntax.md @@ -103,9 +103,8 @@ When using the `local` backend, the `image` entry is used to specify the shell, - go build - go test - - name: publish -+ image: woodpeckerci/plugin-kaniko - repo: foo/bar + - name: prettier ++ image: woodpeckerci/plugin-prettier services: - name: database @@ -473,9 +472,11 @@ Normally steps of a workflow are executed serially in the order in which they ar - go build - name: deploy - image: woodpeckerci/plugin-kaniko + image: woodpeckerci/plugin-s3 settings: - repo: foo/bar + bucket: my-bucket-name + source: some-file-name + target: /target/some-file + depends_on: [build, test] # deploy will be executed after build and test finished - name: test # test will be executed immediately as no dependencies are set diff --git a/docs/docs/20-usage/50-environment.md b/docs/docs/20-usage/50-environment.md index 5ef8553c4..858d5dd2c 100644 --- a/docs/docs/20-usage/50-environment.md +++ b/docs/docs/20-usage/50-environment.md @@ -170,20 +170,20 @@ Example commit substitution: ```diff steps: - - name: docker - image: woodpeckerci/plugin-kaniko + - name: s3 + image: woodpeckerci/plugin-s3 settings: -+ tags: ${CI_COMMIT_SHA} ++ target: /target/${CI_COMMIT_SHA} ``` Example tag substitution: ```diff steps: - - name: docker - image: woodpeckerci/plugin-kaniko + - name: s3 + image: woodpeckerci/plugin-s3 settings: -+ tags: ${CI_COMMIT_TAG} ++ target: /target/${CI_COMMIT_TAG} ``` ## String Operations @@ -208,18 +208,18 @@ Example variable substitution with substring: ```diff steps: - - name: docker - image: woodpeckerci/plugin-kaniko + - name: s3 + image: woodpeckerci/plugin-s3 settings: -+ tags: ${CI_COMMIT_SHA:0:8} ++ target: /target/${CI_COMMIT_SHA:0:8} ``` Example variable substitution strips `v` prefix from `v.1.0.0`: ```diff steps: - - name: docker - image: woodpeckerci/plugin-kaniko + - name: s3 + image: woodpeckerci/plugin-s3 settings: -+ tags: ${CI_COMMIT_TAG##v} ++ target: /target/${CI_COMMIT_TAG##v} ``` diff --git a/docs/docs/20-usage/51-plugins/51-overview.md b/docs/docs/20-usage/51-plugins/51-overview.md index a731a7e97..f2af4f90f 100644 --- a/docs/docs/20-usage/51-plugins/51-overview.md +++ b/docs/docs/20-usage/51-plugins/51-overview.md @@ -23,7 +23,7 @@ steps: template: config/k8s/service.yaml ``` -Example pipeline using the Docker and Prettier plugins: +Example pipeline using the Prettier and S3 plugins: ```yaml steps: @@ -37,10 +37,11 @@ steps: image: woodpeckerci/plugin-prettier - name: publish - image: woodpeckerci/plugin-kaniko + image: woodpeckerci/plugin-s3 settings: - repo: foo/bar - tags: latest + bucket: my-bucket-name + source: some-file-name + target: /target/some-file ``` ## Plugin Isolation