Woodpecker

https://woodpecker-ci.org/docs/
Admin
Woodpecker is a lightweight, fast, and simple CI/CD tool designed to automate continuous integration...
Tokens:80,847
Snippets:856
Trust Score:9.5
Update:1 month ago
Show doc for...
Tokens:
Raw
### Example YAML before injecting matrix parameters

Source: https://woodpecker-ci.org/docs/usage/matrix-workflows

Example YAML file before injecting matrix parameters.

```yaml
matrix:  

  GO_VERSION:  

    - 1.4  

    - 1.3  

  DATABASE:  

    - mysql:8  

    - mysql:5  

    - mariadb:10.1  

  

steps:  

  - name: build  

    image: golang:${GO_VERSION}  

    commands:  

      - go get  

      - go build  

      - go test  

  

services:  

  - name: database  

    image: ${DATABASE}  

```

--------------------------------

### Full Docker in Docker setup with TLS

Source: https://woodpecker-ci.org/docs/usage/advanced-usage

Complete working example for Docker in Docker with TLS. Configures a docker:cli step with DOCKER_* environment variables, volume mounts, and a docker:dind service with TLS certificates.

```yaml
steps:

  - name: test

    image: docker:cli # use 'docker:<major-version>-cli' or similar in production

    environment:

      DOCKER_HOST: 'tcp://docker:2376'

      DOCKER_CERT_PATH: '/dind-certs/client'

      DOCKER_TLS_VERIFY: '1'

    volumes:

      - /opt/woodpeckerci/dind-certs:/dind-certs

    commands:

      - docker version


services:

  - name: docker

    image: docker:dind # use 'docker:<major-version>-dind' or similar in production

    privileged: true

    environment:

      DOCKER_TLS_CERTDIR: /dind-certs

    volumes:

      - /opt/woodpeckerci/dind-certs:/dind-certs

    ports:

      - 2376

```

--------------------------------

### Complete pipeline example with MySQL service

Source: https://woodpecker-ci.org/docs/usage/services

A full pipeline that starts a MySQL service, waits for initialization, and queries the database version using the mysql client.

```yaml
services:  

  - name: database  

    image: mysql  

    environment:  

      MYSQL_DATABASE: test  

      MYSQL_ROOT_PASSWORD: example  

steps:  

  - name: get-version  

    image: ubuntu  

    commands:  

      - ( apt update && apt dist-upgrade -y && apt install -y mysql-client 2>&1 )> /dev/null  

      - sleep 30s # need to wait for mysql-server init  

      - echo 'SHOW VARIABLES LIKE "version"' | mysql -u root -h database test -p example  

```

--------------------------------

### Headless service Docker-in-Docker example

Source: https://woodpecker-ci.org/docs/administration/configuration/backends/kubernetes

Example of using headless services to connect steps via a Docker-in-Docker setup. The 'test' step uses the 'docker' service's hostname as the Docker host and expects TLS certificates from the 'docker' service, which is detached and privileged.

```yaml

steps:  

  - name: test  

    image: docker:cli # use 'docker:<major-version>-cli' or similar in production  

    environment:  

      DOCKER_HOST: 'tcp://docker:2376'  

      DOCKER_CERT_PATH: '/woodpecker/dind-certs/client'  

      DOCKER_TLS_VERIFY: '1'  

    commands:  

      - docker run hello-world  

  

  - name: docker  

    image: docker:dind # use 'docker:<major-version>-dind' or similar in production  

    detach: true  

    privileged: true  

    environment:  

      DOCKER_TLS_CERTDIR: /woodpecker/dind-certs  


```

--------------------------------

### Example YAML after injecting matrix parameters

Source: https://woodpecker-ci.org/docs/usage/matrix-workflows

Example YAML file after injecting the matrix parameters, showing the changes with diff markers.

```yaml
 steps:  

   - name: build  

-    image: golang:${GO_VERSION}  

+    image: golang:1.4  

     commands:  

       - go get  

       - go build  

       - go test  

+    environment:  

+      - GO_VERSION=1.4  

+      - DATABASE=mysql:8  

  

 services:  

   - name: database  

-    image: ${DATABASE}  

+    image: mysql:8  

```

--------------------------------

### Example matrix pipeline using multiple platforms

Source: https://woodpecker-ci.org/docs/usage/matrix-workflows

Example matrix pipeline using multiple platforms.

```yaml
matrix:  

  platform:  

    - linux/amd64  

    - linux/arm64  

  

labels:  

  platform: ${platform}  

  

steps:  

  - name: test  

    image: alpine  

    commands:  

      - echo "I am running on ${platform}"  

  

  - name: test-arm-only  

    image: alpine  

    commands:  

      - echo "I am running on ${platform}"  

      - echo "Arm is cool!"  

    when:  

      platform: linux/arm*  

```

--------------------------------

### WOODPECKER_DATABASE_DATASOURCE examples for MySQL and PostgreSQL

Source: https://woodpecker-ci.org/docs/administration/configuration/server

Example values for the WOODPECKER_DATABASE_DATASOURCE environment variable, showing MySQL and PostgreSQL connection strings. The MySQL example uses the go-sql-driver DSN format; the PostgreSQL example uses the libpq connection string format.

```bash
WOODPECKER_DATABASE_DATASOURCE=root:password@tcp(1.2.3.4:3306)/woodpecker?parseTime=true
```

```bash
WOODPECKER_DATABASE_DATASOURCE=postgres://root:password@1.2.3.4:5432/woodpecker?sslmode=disable
```

--------------------------------

### Start server with go run ./cmd/server

Source: https://woodpecker-ci.org/docs/development/getting-started

Runs the Woodpecker server from the terminal.

```go
go run ./cmd/server  

```

--------------------------------

### Example matrix pipeline based on Docker image tag

Source: https://woodpecker-ci.org/docs/usage/matrix-workflows

Example matrix pipeline based on Docker image tag.

```yaml
matrix:  

  TAG:  

    - 1.7  

    - 1.8  

    - latest  

  

steps:  

  - name: build  

    image: golang:${TAG}  

    commands:  

      - go build  

      - go test  

```

--------------------------------

### Example matrix pipeline based on container image

Source: https://woodpecker-ci.org/docs/usage/matrix-workflows

Example matrix pipeline based on container image.

```yaml
matrix:  

  IMAGE:  

    - golang:1.7  

    - golang:1.8  

    - golang:latest  

  

steps:  

  - name: build  

    image: ${IMAGE}  

    commands:  

      - go build  

      - go test  

```

--------------------------------

### Forge addon example using addon.Serve

Source: https://woodpecker-ci.org/docs/development/addons

Example structure for a forge addon. Imports Woodpecker's Go packages and calls `addon.Serve` with a config that must implement the `Forge` interface. The addon runs in a separate process, so global variables from Woodpecker are not accessible.

```go
package main

import (
  "context"
  "net/http"

  "go.woodpecker-ci.org/woodpecker/v3/server/forge/addon"
  forgeTypes "go.woodpecker-ci.org/woodpecker/v3/server/forge/types"
  "go.woodpecker-ci.org/woodpecker/v3/server/model"
)

func main() {
  addon.Serve(config{})
}

type config struct {
}

// `config` must implement `"go.woodpecker-ci.org/woodpecker/v3/server/forge".Forge`. You must directly use Woodpecker's packages - see imports above.
```

--------------------------------

### Webhook plugin configuration example

Source: https://woodpecker-ci.org/docs/usage/plugins/creating-plugins

Example YAML configuration for a webhook plugin, showing how users would set url, method, and body settings.

```yaml
steps:

  - name: webhook

    image: foo/webhook

    settings:

      url: https://example.com

      method: post

      body: |

        hello world
```

--------------------------------

### Example response for registry extension

Source: https://woodpecker-ci.org/docs/usage/extensions/registry-extension

Example JSON response containing a list of registry credentials. Each entry includes the docker registry address, username, and password.

```json
{
  "registries": [
    {
      "address": "docker.io",
      "username": "woodpecker-bot",
      "password": "your-pass-word-123"
    }
  ]
}
```

--------------------------------

### Dummy backend pipeline configuration example

Source: https://woodpecker-ci.org/docs/development/testing

Example pipeline configuration for the dummy backend. It defines a step named 'echo' and a service named 'echo', both using the 'dummy' image. The step sets the SLEEP environment variable to '1s'. This configuration is executed with the command: woodpecker-cli --log-level trace exec --backend-engine dummy example.yaml.

```yaml
when:
  event: manual

steps:
  - name: echo
    image: dummy
    commands: echo "hello woodpecker"
    environment:
      SLEEP: '1s'

services:
  echo:
    image: dummy
    commands: echo "i am a service"
```

--------------------------------

### Example request for registry extension

Source: https://woodpecker-ci.org/docs/usage/extensions/registry-extension

An example JSON request payload sent to the registry extension. This example is likely outdated, so check the repo, pipeline, and netrc models for the current structure.

```json
{
  "repo": {
    "id": 100,
    "uid": "",
    "user_id": 0,
    "namespace": "",
    "name": "woodpecker-test-pipeline",
    "slug": "",
    "scm": "git",
    "git_http_url": "",
    "git_ssh_url": "",
    "link": "",
    "default_branch": "",
    "private": true,
    "visibility": "private",
    "active": true,
    "config": "",
    "trusted": false,
    "protected": false,
    "ignore_forks": false,
    "ignore_pulls": false,
    "cancel_pulls": false,
    "timeout": 60,
    "counter": 0,
    "synced": 0,
    "created": 0,
    "updated": 0,
    "version": 0
  },
  "pipeline": {
    "author": "myUser",
    "author_avatar": "https://myforge.com/avatars/d6b3f7787a685fcdf2a44e2c685c7e03",
    "author_email": "my@email.com",
    "branch": "main",
    "changed_files": ["some-filename.txt"],
    "commit": "2fff90f8d288a4640e90f05049fe30e61a14fd50",
    "created_at": 0,
    "deploy_to": "",
    "enqueued_at": 0,
    "error": "",
    "event": "push",
    "finished_at": 0,
    "id": 0,
    "link_url": "https://myforge.com/myUser/woodpecker-testpipe/commit/2fff90f8d288a4640e90f05049fe30e61a14fd50",
    "message": "test old config\n",
    "number": 0,
    "parent": 0,
    "ref": "refs/heads/main",
    "refspec": "",
    "clone_url": "",
    "reviewed_at": 0,
    "reviewed_by": "",
    "sender": "myUser",
    "signed": false,
    "started_at": 0,
    "status": "",
    "timestamp": 1645962783,
    "title": "",
    "updated_at": 0,
    "verified": false
  },
  "netrc": {
    "machine": "myforge.com",
    "login": "myUser",
    "password": "forge-access-token"
  }
}
```

--------------------------------

### Docker command to execute script

Source: https://woodpecker-ci.org/docs/usage/workflow-syntax

Incomplete example of how the generated script is executed as the container entrypoint.

```sh
docker run --entrypoint=build.sh golang  

```

--------------------------------

### Example configuration using a private image

Source: https://woodpecker-ci.org/docs/usage/registries

Shows a pipeline step using a private image from gcr.io/custom/golang. Registry credentials are provided in the UI and are never exposed to steps.

```yaml
steps:  

  - name: build  

    image: gcr.io/custom/golang  

    commands:  

      - go build  

      - go test  

```

--------------------------------

### Install Woodpecker Helm chart

Source: https://woodpecker-ci.org/docs/administration/installation/helm-chart

Installs the Woodpecker CI Helm chart from the ghcr.io/woodpecker-ci/helm/woodpecker OCI registry. Replace <VERSION> with the desired chart version.

```bash
helm install woodpecker oci://ghcr.io/woodpecker-ci/helm/woodpecker --version <VERSION>

```

--------------------------------

### Example response payload

Source: https://woodpecker-ci.org/docs/usage/extensions/configuration-extension

Shows an example response containing a single configuration file named 'central-override' with a YAML pipeline definition.

```json
{  

  "configs": [  

    {  

      "name": "central-override",  

      "data": "steps:\n  - name: backend\n    image: alpine\n    commands:\n      - echo \"Hello there from ConfigAPI\"\n"  

    }  

  ]  

}  
```

--------------------------------

### Start agent with go run ./cmd/agent

Source: https://woodpecker-ci.org/docs/development/getting-started

Runs the Woodpecker agent from the terminal.

```go
go run ./cmd/agent  

```

--------------------------------

### Install docker-credential-ecr-login in Woodpecker server image

Source: https://woodpecker-ci.org/docs/administration/configuration/backends/docker

Builds a custom Woodpecker server image that installs the docker-credential-ecr-login helper, which is required to use Docker credentials with private registries. The helper is added via apk in the Alpine-based image.

```dockerfile
FROM woodpeckerci/woodpecker-server:latest-alpine  

RUN apk add -U --no-cache docker-credential-ecr-login  
```

--------------------------------

### Configure MySQL/MariaDB database connection

Source: https://woodpecker-ci.org/docs/administration/configuration/server

Set the database driver and datasource environment variables to connect to a MySQL or MariaDB instance. Ensure the database is created manually before starting the server.

```bash
WOODPECKER_DATABASE_DRIVER=mysql  

WOODPECKER_DATABASE_DATASOURCE=root:password@tcp(1.2.3.4:3306)/woodpecker?parseTime=true  
```

--------------------------------

### Woodpecker server environment file

Source: https://woodpecker-ci.org/docs/administration/installation/packages

Example environment file for the Woodpecker server, located at /etc/woodpecker/woodpecker-server.env. It contains placeholders for the host, GitHub OAuth client and secret, and agent secret. Copy from the example file and adjust values.

```ini
WOODPECKER_OPEN=true
WOODPECKER_HOST=${WOODPECKER_HOST}
WOODPECKER_GITHUB=true
WOODPECKER_GITHUB_CLIENT=${WOODPECKER_GITHUB_CLIENT}
WOODPECKER_GITHUB_SECRET=${WOODPECKER_GITHUB_SECRET}
WOODPECKER_AGENT_SECRET=${WOODPECKER_AGENT_SECRET}
```

--------------------------------

### Example matrix definition

Source: https://woodpecker-ci.org/docs/usage/matrix-workflows

Defines a matrix with two axes: GO_VERSION and REDIS_VERSION, each with multiple values.

```yaml
matrix:  

  GO_VERSION:  

    - 1.4  

    - 1.3  

  REDIS_VERSION:  

    - 2.6  

    - 2.8  

    - 3.0  

```

--------------------------------

### Example matrix definition with include

Source: https://woodpecker-ci.org/docs/usage/matrix-workflows

Defines a matrix with only specific combinations using the include keyword.

```yaml
matrix:  

  include:  

    - GO_VERSION: 1.4  

      REDIS_VERSION: 2.6  

    - GO_VERSION: 1.4  

      REDIS_VERSION: 2.8  

    - GO_VERSION: 1.4  

      REDIS_VERSION: 3.0  

    - GO_VERSION: 1.3  

      REDIS_VERSION: 2.6  

    - GO_VERSION: 1.3  

      REDIS_VERSION: 2.8  

    - GO_VERSION: 1.3  

      REDIS_VERSION: 3.0  

```

--------------------------------

### Complex settings YAML example

Source: https://woodpecker-ci.org/docs/usage/plugins/creating-plugins

Shows how to define complex settings in a pipeline step. These are converted to JSON and passed as an environment variable, e.g., PLUGIN_COMPLEX.

```yaml
steps:

  - name: plugin

    image: foo/plugin

    settings:

      complex:

        abc: 2

        list:

          - 2

          - 3
```

--------------------------------

### Kubernetes deploy plugin example (Dockerfile, deploy script, pipeline step)

Source: https://woodpecker-ci.org/docs/usage/plugins/overview

Shows the three files that make up a simple Kubernetes deploy plugin: a Dockerfile that builds the plugin image, a deploy script that runs kubectl apply using the PLUGIN_TEMPLATE environment variable, and a pipeline step that uses the plugin with a template setting. The plugin is invoked as a step in the pipeline and receives the template path via settings.

```dockerfile
FROM cloud/kubectl  

COPY deploy /usr/local/deploy  

ENTRYPOINT ["/usr/local/deploy"]  

```

```shell
kubectl apply -f $PLUGIN_TEMPLATE  

```

```yaml
steps:  

  - name: deploy-to-k8s  

    image: cloud/my-k8s-plugin  

    settings:  

      template: config/k8s/service.yaml  

```

--------------------------------

### Install Woodpecker packages (DEB/RPM)

Source: https://woodpecker-ci.org/docs/administration/installation/packages

Downloads the latest release version and installs the server, agent, and CLI packages for Debian/Ubuntu (x86_64) or CentOS/RHEL (x86_64). The DEB installation uses apt with --fix-broken, and the RPM installation uses dnf.

```bash
RELEASE_VERSION=$(curl -s https://api.github.com/repos/woodpecker-ci/woodpecker/releases/latest | grep -Po '"tag_name":\s"v\K[^"]+')

# Debian/Ubuntu (x86_64)
curl -fLOOO "https://github.com/woodpecker-ci/woodpecker/releases/download/v${RELEASE_VERSION}/woodpecker-{server,agent,cli}_${RELEASE_VERSION}_amd64.deb"
sudo apt --fix-broken install ./woodpecker-{server,agent,cli}_${RELEASE_VERSION}_amd64.deb

# CentOS/RHEL (x86_64)
sudo dnf install https://github.com/woodpecker-ci/woodpecker/releases/download/v${RELEASE_VERSION}/woodpecker-{server,agent,cli}-${RELEASE_VERSION}.x86_64.rpm
```

--------------------------------

### Build Server Component

Source: https://woodpecker-ci.org/docs/development/guides

Steps to build the web component, cross-compile the server, and build the Docker image for the server.

```bash
make vendor

cd web/

pnpm install --frozen-lockfile

pnpm build

cd ..



### define the platforms to build for (e.g. linux/amd64)

# (the | is not a typo here)

export PLATFORMS='linux|amd64'

make cross-compile-server



### build the image

docker buildx build --platform linux/amd64 -t username/repo:tag -f docker/Dockerfile.server.multiarch.rootless --push .
```

--------------------------------

### Run and build Docusaurus docs locally

Source: https://woodpecker-ci.org/docs/development/docs

Use these commands to run and build the Docusaurus documentation locally. Requires Node.js and pnpm. The start command enables hot-reloading, while the build command produces a static site for deployment.

```bash
cd docs/

pnpm install

# build plugins used by the docs
pnpm build:woodpecker-plugins

# start docs with hot-reloading, so you can change the docs and directly see the changes in the browser without reloading it manually
pnpm start

# or build the docs to deploy it to some static page hosting
pnpm build
```

--------------------------------

### Example secret extension request JSON

Source: https://woodpecker-ci.org/docs/usage/extensions/secret-extension

Example JSON request payload sent to the secret extension. The `netrc` field is omitted when netrc sending is not enabled. The comment notes that the example may be outdated and to check the latest models.

```json
// Please check the latest structure in the models mentioned above.  
// This example is likely outdated.  

{  
  "repo": {  
    "id": 100,  
    "uid": "",  
    "user_id": 0,  
    "namespace": "",  
    "name": "woodpecker-test-pipeline",  
    "slug": "",  
    "scm": "git",  
    "git_http_url": "",  
    "git_ssh_url": "",  
    "link": "",  
    "default_branch": "",  
    "private": true,  
    "visibility": "private",  
    "active": true,  
    "config": "",  
    "trusted": false,  
    "protected": false,  
    "ignore_forks": false,  
    "ignore_pulls": false,  
    "cancel_pulls": false,  
    "timeout": 60,  
    "counter": 0,  
    "synced": 0,  
    "created": 0,  
    "updated": 0,  
    "version": 0  
  },  
  "pipeline": {  
    "author": "myUser",  
    "author_avatar": "https://myforge.com/avatars/d6b3f7787a685fcdf2a44e2c685c7e03",  
    "author_email": "my@email.com",  
    "branch": "main",  
    "changed_files": ["some-filename.txt"],  
    "commit": "2fff90f8d288a4640e90f05049fe30e61a14fd50",  
    "created_at": 0,  
    "deploy_to": "",  
    "enqueued_at": 0,  
    "error": "",  
    "event": "push",  
    "finished_at": 0,  
    "id": 0,  
    "link_url": "https://myforge.com/myUser/woodpecker-testpipe/commit/2fff90f8d288a4640e90f05049fe30e61a14fd50",  
    "message": "test old config\n",  
    "number": 0,  
    "parent": 0,  
    "ref": "refs/heads/main",  
    "refspec": "",  
    "clone_url": "",  
    "reviewed_at": 0,  
    "reviewed_by": "",  
    "sender": "myUser",  
    "signed": false,  
    "started_at": 0,  
    "status": "",  
    "timestamp": 1645962783,  
    "title": "",  
    "updated_at": 0,  
    "verified": false  
  },  
  "netrc": {  
    "machine": "myforge.com",  
    "login": "myUser",  
    "password": "forge-access-token"  
  }  
}  
// Note: the "netrc" field is omitted when netrc sending is not enabled.  

```

--------------------------------

### ref: Run on tags starting with v

Source: https://woodpecker-ci.org/docs/usage/workflow-syntax

Execute a step when a tag starts with 'v'. This filter checks the git reference.

```yaml
when:

  - event: tag

    ref: refs/tags/v*


```

--------------------------------

### Start Tunnelmole tunnel

Source: https://woodpecker-ci.org/docs/administration/configuration/server

Starts a Tunnelmole tunnel on port 8000. After running, set WOODPECKER_HOST to the provided Tunnelmole URL.

```bash
tmole 8000  

```

--------------------------------

### Configure service environment variables

Source: https://woodpecker-ci.org/docs/usage/services

Shows how to pass environment variables to service containers to customize startup, such as database credentials.

```yaml
 services:  

   - name: database  

     image: mysql  

+    environment:  

+      MYSQL_DATABASE: test  

+      MYSQL_ALLOW_EMPTY_PASSWORD: yes  

  

   - name: cache  

     image: redis  

```

--------------------------------

### ConfigAPI response structure example

Source: https://woodpecker-ci.org/docs/administration/configuration/server

Example response structure from the ConfigAPI, containing a configuration named central-override with a YAML pipeline definition.

```json
{  

  "configs": [  

    {  

      "name": "central-override",  

      "data": "steps:\n  - name: backend\n    image: alpine\n    commands:\n      - echo \"Hello there from ConfigAPI\"\n"  

    }  

  ]  

}  


```

--------------------------------

### Build and publish plugin

Source: https://woodpecker-ci.org/docs/usage/plugins/creating-plugins

Commands to build and push the plugin Docker image to a registry.

```sh
docker build -t foo/webhook .
docker push foo/webhook
```

--------------------------------

### Start ngrok tunnel

Source: https://woodpecker-ci.org/docs/administration/configuration/server

Starts an ngrok tunnel on port 8000. After running, set WOODPECKER_HOST to the ngrok URL (usually xxx.ngrok.io).

```bash
ngrok http 8000  

```

--------------------------------

### Pipeline using Prettier and S3 plugins

Source: https://woodpecker-ci.org/docs/usage/plugins/overview

Example pipeline that builds and tests a Go project, then runs the Prettier plugin and the S3 plugin to publish an artifact. The S3 plugin is configured with bucket, source, and target settings.

```yaml
steps:  

  - name: build  

    image: golang  

    commands:  

      - go build  

      - go test  

  

  - name: prettier  

    image: woodpeckerci/plugin-prettier  

  

  - name: publish  

    image: woodpeckerci/plugin-s3  

    settings:  

      bucket: my-bucket-name  

      source: some-file-name  

      target: /target/some-file  

```

--------------------------------

### YAML example with Docker socket volume

Source: https://woodpecker-ci.org/docs/usage/volumes

Shows a step named 'build' using the Docker image and mounting the host Docker socket into the container via the `volumes` parameter. The volume is added with a plus sign, indicating a diff or addition. Volumes are only available to trusted repositories.

```yaml
 steps:  

   - name: build  

     image: docker  

     commands:  

       - docker build --rm -t octocat/hello-world .  

       - docker run --rm octocat/hello-world --test  

       - docker push octocat/hello-world  

       - docker rmi octocat/hello-world  

     volumes:  

+      - /var/run/docker.sock:/var/run/docker.sock  

```

--------------------------------

### Example secret extension response JSON

Source: https://woodpecker-ci.org/docs/usage/extensions/secret-extension

Example JSON response containing a `secrets` array. The first secret has no restrictions, while the second is restricted to `push` and `tag` events.

```json
{  
  "secrets": [  
    {  
      "name": "docker_password",  
      "value": "your-secret-password-123"  
    },  
    {  
      "name": "deploy_token",  
      "value": "super-secret-token",  
      "events": ["push", "tag"]  
    }  
  ]  
}  

```

--------------------------------

### branch: Wildcard pattern

Source: https://woodpecker-ci.org/docs/usage/workflow-syntax

Execute a step when the branch starts with 'prefix/'. Uses doublestar pattern matching; patterns starting with '*' should be quoted and a literal '/' needs to be escaped.

```yaml
when:

  - branch: prefix/*


```

--------------------------------

### Example request payload

Source: https://woodpecker-ci.org/docs/usage/extensions/configuration-extension

Shows a full example of the JSON payload sent to the extension, including repository, pipeline, configuration, and netrc fields. The netrc field is present because netrc sending is enabled.

```json
{  

  "repo": {  

    "id": 100,  

    "uid": "",  

    "user_id": 0,  

    "namespace": "",  

    "name": "woodpecker-test-pipeline",  

    "slug": "",  

    "scm": "git",  

    "git_http_url": "",  

    "git_ssh_url": "",  

    "link": "",  

    "default_branch": "",  

    "private": true,  

    "visibility": "private",  

    "active": true,  

    "config": "",  

    "trusted": false,  

    "protected": false,  

    "ignore_forks": false,  

    "ignore_pulls": false,  

    "cancel_pulls": false,  

    "timeout": 60,  

    "counter": 0,  

    "synced": 0,  

    "created": 0,  

    "updated": 0,  

    "version": 0  

  },  

  "pipeline": {  

    "author": "myUser",  

    "author_avatar": "https://myforge.com/avatars/d6b3f7787a685fcdf2a44e2c685c7e03",  

    "author_email": "my@email.com",  

    "branch": "main",  

    "changed_files": ["some-filename.txt"],  

    "commit": "2fff90f8d288a4640e90f05049fe30e61a14fd50",  

    "created_at": 0,  

    "deploy_to": "",  

    "enqueued_at": 0,  

    "error": "",  

    "event": "push",  

    "finished_at": 0,  

    "id": 0,  

    "link_url": "https://myforge.com/myUser/woodpecker-testpipe/commit/2fff90f8d288a4640e90f05049fe30e61a14fd50",  

    "message": "test old config\n",  

    "number": 0,  

    "parent": 0,  

    "ref": "refs/heads/main",  

    "refspec": "",  

    "clone_url": "",  

    "reviewed_at": 0,  

    "reviewed_by": "",  

    "sender": "myUser",  

    "signed": false,  

    "started_at": 0,  

    "status": "",  

    "timestamp": 1645962783,  

    "title": "",  

    "updated_at": 0,  

    "verified": false  

  },  

  "configuration": [  

    {  

      "name": ".woodpecker.yaml",  

      "data": "steps:\n  - name: backend\n    image: alpine\n    commands:\n      - echo \"Hello there from Repo (.woodpecker.yaml)\"\n"  

    }  

  ],  

  "netrc": {  

    "machine": "myforge.com",  

    "login": "myUser",  

    "password": "forge-access-token"  

  }  

}  
```

--------------------------------

### Test UI code with make test-frontend

Source: https://woodpecker-ci.org/docs/development/getting-started

Runs the test suite for UI code.

```bash
make test-frontend  

```

--------------------------------

### Woodpecker agent environment file

Source: https://woodpecker-ci.org/docs/administration/installation/packages

Example environment file for the Woodpecker agent, located at /etc/woodpecker/woodpecker-agent.env. It contains the server address and agent secret. Copy from the example file and adjust values; the agent will automatically register with the server.

```ini
WOODPECKER_SERVER=localhost:9000
WOODPECKER_AGENT_SECRET=${WOODPECKER_AGENT_SECRET}
```

--------------------------------

### Specifying images for steps and services

Source: https://woodpecker-ci.org/docs/usage/workflow-syntax

Shows how to set the image for a step and a service. The image is pulled and used as the environment for executing commands.

```yaml
 steps:  

   - name: build  

+    image: golang:1.6  

     commands:  

       - go build  

       - go test  

  

   - name: prettier  

+    image: woodpeckerci/plugin-prettier  

  

 services:  

   - name: database  

+    image: mysql  

```

--------------------------------

### Build Woodpecker server with external web UI root path

Source: https://woodpecker-ci.org/docs/development/packaging

This command builds the Woodpecker server with the web UI kept in an external directory by appending the 'external_web' tag to the build tags. The 'web.webUIRoot' linker flag sets a custom path for the web UI, and other flags optimize the binary size (through -s -w) and enable static linking via -extldflags.

```bash
go build -tags 'external_web' -ldflags '-s -w -extldflags "-static" -X go.woodpecker-ci.org/woodpecker/v3/version.Version=3.12.0 -X go.woodpecker-ci.org/woodpecker/v3/web.webUIRoot=/nix/store/maaajlp8h5gy9zyjgfhaipzj07qnnmrl-woodpecker-WebUI-3.12.0' -o dist/woodpecker-server go.woodpecker-ci.org/woodpecker/v3/cmd/server
```

--------------------------------

### Customize workspace with base and path in YAML.

Source: https://woodpecker-ci.org/docs/usage/workflow-syntax

Sets a custom workspace base to /go and path to the repository, then runs a Golang build step.

```yaml
+workspace:  

+  base: /go  

+  path: src/github.com/octocat/hello-world  

  

 steps:  

   - name: build  

     image: golang:latest  

     commands:  

       - go get  

       - go test  

```

--------------------------------

### Lint Go code with make lint

Source: https://woodpecker-ci.org/docs/development/getting-started

Runs the linter for Go code.

```bash
make lint  

```

--------------------------------

### Lint UI code with make lint-frontend

Source: https://woodpecker-ci.org/docs/development/getting-started

Runs the linter for UI code.

```bash
make lint-frontend  

```

--------------------------------

### Define first workflow in .woodpecker/my-first-workflow.yaml

Source: https://woodpecker-ci.org/docs/usage/intro

Creates a workflow that runs on push events to the main branch. It defines two steps: 'build' using the debian image to create a file, and 'a-test-step' using alpine to output the file contents. Steps execute in order.

```yaml
when:  

  - event: push  

    branch: main  

  

steps:  

  - name: build  

    image: debian  

    commands:  

      - echo "This is the build step"  

      - echo "some-data" > some-file.txt  

  - name: a-test-step  

    image: alpine  

    commands:  

      - echo "Testing ..."  

      - cat some-file.txt  


```

--------------------------------

### Valid Docker image formats

Source: https://woodpecker-ci.org/docs/usage/workflow-syntax

Lists examples of valid Docker image references that Woodpecker supports.

```yaml
image: golang  

image: golang:1.7  

image: library/golang:1.7  

image: index.docker.io/library/golang  

image: index.docker.io/library/golang:1.7  

```

--------------------------------

### Build CLI Component

Source: https://woodpecker-ci.org/docs/development/guides

Commands to build the CLI binary and its corresponding Docker image.

```bash
make build-cli



### build the image

docker buildx build --platform linux/amd64 -t username/repo:tag -f docker/Dockerfile.cli.multiarch.rootless --push .
```
Tokens:
Raw