Woodpecker

https://github.com/woodpecker-ci/woodpecker
Admin
Woodpecker is a simple, yet powerful CI/CD engine with great extensibility, designed to be a...
Tokens:113,715
Snippets:990
Trust Score:8.2
License:Apache-2.0
Update:4 weeks ago
Show doc for...
Tokens:
Raw
### Complete pipeline with MySQL service

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/docs/20-usage/60-services.md

Complete pipeline example with a MySQL service and a step that installs the MySQL client, waits for initialization, and queries the server version. Demonstrates service hostname access and environment configuration.

```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

```

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

### Full Docker-in-Docker TLS example

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/docs/20-usage/90-advanced-usage.md

Complete Docker-in-Docker setup with TLS: a docker:cli step and a docker:dind service sharing a certificates volume. The step runs docker version to verify the connection.

```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
```

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

### Start local development server

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/README.md

Starts a local development server and opens a browser window. Changes are reflected live without restarting.

```bash
pnpm start
```

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

### Extract and install Woodpecker binaries

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/docs/30-administration/05-installation/30-packages.md

Extracts the downloaded server and agent tarballs and installs the binaries to /usr/local/bin/. This example uses Linux ARM64; adjust tarball names for your architecture.

```shell
tar -xzf woodpecker-server_linux_arm64.tar.gz
tar -xzf woodpecker-agent_linux_arm64.tar.gz
sudo install -m 755 woodpecker-server woodpecker-agent /usr/local/bin/
```

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

### Run and build Docusaurus docs locally

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/docs/92-development/04-docs.md

Run these commands from the repository root to set up and run the Docusaurus documentation site locally. Requires Node.js and pnpm installed. `pnpm start` enables hot-reloading; `pnpm build` produces a static build 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
```

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

### WOODPECKER_DATABASE_DATASOURCE examples for MySQL and PostgreSQL

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/docs/30-administration/10-configuration/10-server.md

Example connection strings for the WOODPECKER_DATABASE_DATASOURCE environment variable. The MySQL example uses the go-sql-driver DSN format, and 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
```

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

### Docker run with entrypoint

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/docs/20-usage/20-workflow-syntax.md

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

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

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

### Dummy backend example pipeline configuration

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/docs/92-development/09-testing.md

Example pipeline configuration for the dummy backend. It defines a manual event, a step named 'echo' using the dummy image, and a service also named 'echo'. The step sets the SLEEP environment variable to '1s'.

```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"

```

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

### woodpecker-server.env example

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/docs/30-administration/05-installation/30-packages.md

Example environment file for the Woodpecker server. Copy /etc/woodpecker/woodpecker-server.env.example to /etc/woodpecker/woodpecker-server.env and adjust the values, including the GitHub OAuth client and secret and the agent secret.

```shell
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}
```

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

### woodpecker-agent.env example

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/docs/30-administration/05-installation/30-packages.md

Example environment file for the Woodpecker agent. Copy /etc/woodpecker/woodpecker-agent.env.example to /etc/woodpecker/woodpecker-agent.env and adjust the values; the agent will automatically register itself with the server.

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

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

### Install dependencies with pnpm

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/README.md

Installs all required dependencies for the Docusaurus website using pnpm.

```bash
pnpm install
```

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

### Example steps with dictionary syntax

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/docs/20-usage/20-workflow-syntax.md

Alternative way to define steps using dictionaries, where step names are keys. The names are arbitrary.

```yaml
steps:
  backend:
    image: golang
    commands:
      - go build
      - go test
  frontend:
    image: node
    commands:
      - npm install
      - npm run test
      - npm run build

```

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

### Start server with go run

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/docs/92-development/01-getting-started.md

Runs the Woodpecker server from the terminal. Use this command from the base of the Woodpecker project.

```bash
go run ./cmd/server
```

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

### Install Woodpecker Helm Chart

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/docs/30-administration/05-installation/20-helm-chart.md

Installs the Woodpecker Helm chart from the OCI registry. Replace <VERSION> with the desired chart version.

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

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

### Example response JSON payload

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/docs/20-usage/72-extensions/50-registry-extension.md

Shows an example of the JSON response from the registry extension, containing a list of registry credentials.

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

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

### Set TLS Certificate and Key Environment Variables

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/docs/30-administration/10-configuration/10-server.md

Mount certificates into the container and set these environment variables to enable TLS support. Use these paths as examples.

```ini
WOODPECKER_SERVER_CERT=/etc/certs/woodpecker.example.com/server.crt
WOODPECKER_SERVER_KEY=/etc/certs/woodpecker.example.com/server.key
```

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

### Example request JSON payload

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/docs/20-usage/72-extensions/50-registry-extension.md

Shows an example of the JSON payload sent to the registry extension. Note that the structure may be outdated; refer to the linked models for the latest structure.

```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"
  }
}
```

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

### Pipeline using Prettier and S3 plugins

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/docs/20-usage/51-plugins/51-overview.md

Example pipeline that builds a Go project, runs the Prettier plugin, and publishes to S3 using the woodpeckerci/plugin-s3 plugin.

```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
```

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

### Start Ngrok Tunnel

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/docs/30-administration/10-configuration/10-server.md

Run ngrok to create a tunnel to the Woodpecker server. Set WOODPECKER_HOST to the ngrok URL (usually xxx.ngrok.io).

```bash
ngrok http 8000
```

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

### Docker commands for custom base volume

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/docs/20-usage/20-workflow-syntax.md

Equivalent Docker commands for the custom base volume example. Creates a named volume and mounts it to /go for both containers.

```bash
docker volume create my-named-volume

docker run --volume=my-named-volume:/go golang:latest
docker run --volume=my-named-volume:/go node:latest
```

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

### Example steps with list syntax

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/docs/20-usage/20-workflow-syntax.md

Defines two steps, 'backend' and 'frontend', executed serially. If a step returns a non-zero exit code, the pipeline terminates immediately.

```yaml
steps:
  - name: backend
    image: golang
    commands:
      - go build
      - go test
  - name: frontend
    image: node
    commands:
      - npm install
      - npm run test
      - npm run build

```

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

### Debug pipeline step with sshx

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/blog/2023-12-13-debug-pipeline-steps/index.md

Add this step to a Woodpecker pipeline to start an interactive sshx remote terminal session for debugging. The command downloads and runs the sshx installer, then opens a session that prints a URL within about a second.

```yaml
steps:
  - name: debug
    image: alpine
    commands:
      - curl -sSf https://sshx.io/get | sh && sshx
      #      ^
      #      └ This will open a remote terminal session and print the URL. It
      #        should take under a second.
```

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

### Enable Bitbucket with environment variables

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/docs/30-administration/10-configuration/12-forges/50-bitbucket.md

Enable the Bitbucket driver and configure the OAuth client key and secret. The client key is called "Key" in Bitbucket.

```ini
WOODPECKER_BITBUCKET=true
WOODPECKER_BITBUCKET_CLIENT=... # called "Key" in Bitbucket
WOODPECKER_BITBUCKET_SECRET=...
```

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

### Build Server Docker Image Locally

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/docs/92-development/07-guides.md

Commands to build the web component and cross-compiled server binary, then build the rootless server Docker image. Requires an amd64 host because the cross-compile-server rule uses xgo; the build-server rule alternative may fail on some OSes. Set the platform via PLATFORMS using a pipe separator.

```shell
### build web component
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 .
```

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

### Install Woodpecker DEB/RPM packages

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/docs/30-administration/05-installation/30-packages.md

Downloads and installs the official Woodpecker DEB and RPM packages for the latest release. The script fetches the latest release version from the GitHub API, then installs the server, agent, and CLI packages using apt (Debian/Ubuntu) or dnf (CentOS/RHEL).

```Shell
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}-1.x86_64.rpm
```

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

### Tunnelmole Tunnel Output Example

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/docs/30-administration/10-configuration/10-server.md

Example output from the tmole command showing the forwarding URLs. Shows the expected format for the WOODPECKER_HOST value.

```bash
➜  ~ tmole 8000
http://bvdo5f-ip-49-183-170-144.tunnelmole.net is forwarding to localhost:8000
https://bvdo5f-ip-49-183-170-144.tunnelmole.net is forwarding to localhost:8000
```

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

### Create Woodpecker configuration directory and environment files

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/docs/30-administration/05-installation/30-packages.md

Creates the /etc/woodpecker directory and opens the server and agent environment files for editing. Replace ${...} placeholders with your values, including the public WOODPECKER_HOST URL and a shared WOODPECKER_AGENT_SECRET.

```shell
sudo mkdir -p /etc/woodpecker
sudoedit /etc/woodpecker/woodpecker-server.env
sudoedit /etc/woodpecker/woodpecker-agent.env
```

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

### Branch condition: wildcard prefix

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/docs/20-usage/20-workflow-syntax.md

Executes a step if the branch starts with `prefix/*`. Branch matching uses doublestar; patterns starting with `*` should be quoted and literal `/` escaped.

```yaml
when:
  - branch: prefix/*
```

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

### Merge YAML sequences with <<

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/docs/20-usage/90-advanced-usage.md

Shows how to merge YAML sequences using the << merge key. Demonstrates prepending and appending sequences to a commands list, including merging two sequences at once.

```yaml
variables:
  pre_cmds: &pre_cmds
    - echo start
    - whoami
  post_cmds: &post_cmds
    - echo stop
  hello_cmd: &hello_cmd
    - echo hello

steps:
  - name: step1
    image: debian
    commands:
      - <<: *pre_cmds # prepend a sequence
      - echo exec step now do dedicated things
      - <<: *post_cmds # append a sequence
  - name: step2
    image: debian
    commands:
      - <<: [*pre_cmds, *hello_cmd] # prepend two sequences
      - echo echo from second step
      - <<: *post_cmds
```

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

### Example response JSON

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/docs/20-usage/72-extensions/55-secret-extension.md

Example JSON response from the secret extension, showing a secrets array with two secrets. The second secret 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"]
    }
  ]
}
```

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

### Example request JSON payload

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/docs/20-usage/72-extensions/55-secret-extension.md

Example JSON payload sent to the secret extension. Note that the netrc field is omitted when netrc sending is not enabled. The structure may be outdated; refer to the linked models for the latest structure.

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

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

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

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/docs/20-usage/10-intro.md

This workflow triggers on push events to the main branch. It defines two steps: 'build' (using the debian image) and 'a-test-step' (using the alpine image). The steps run in order, and the build step creates a file that the test step reads.

```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
```

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

### Example response payload for configuration extension

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/docs/20-usage/72-extensions/40-configuration-extension.md

Example JSON response payload from the configuration extension. It contains the new configuration files in Woodpecker's official YAML format. The extension can also respond with HTTP 204 No Content to keep existing configurations.

```json
{
  "configs": [
    {
      "name": "central-override",
      "data": "steps:\n  - name: backend\n    image: alpine\n    commands:\n      - echo \"Hello there from ConfigAPI\"\n"
    }
  ]
}
```

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

### Woodpecker workflow with sigstore signing and verification

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/blog/2023-12-15-podman-sigstore/index.md

Defines a two-step pipeline: build the Go binary, then use Podman to configure sigstore policy, sign, and push the image. Requires trusted settings and secrets.

```yaml
steps:
  build:
    image: docker.io/library/golang:1.21
    pull: true
    commands:
      - make build

  publish:
    image: quay.io/podman/stable:latest
    # Caution: This image is built daily. It might fill up your image store quickly.
    pull: true
    # Fill in the trusted checkbox in Woodpecker's settings as well
    privileged: true
    commands:
      # Configure podman to use sigstore attachments for both, the registry you pull from and the registry you push to.
      - |
        printf "docker:
          registry.gitlab.com:
            use-sigstore-attachments: true
          gcr.io:
            use-sigstore-attachments: true" >> /etc/containers/registries.d/default.yaml

      # At pull, check the keyless sigstore signature of the distroless image.
      # This is a very strict container policy. It allows pulling from gcr.io/distroless only. Every other registry will be rejected.
      # See https://github.com/containers/image/blob/main/docs/containers-policy.json.5.md for more information.

      # fulcio CA crt obtained from https://github.com/sigstore/sigstore/blob/main/pkg/tuf/repository/targets/fulcio_v1.crt.pem
      # rekor public key obtained from https://github.com/sigstore/sigstore/blob/main/pkg/tuf/repository/targets/rekor.pub
      # crt/key data is base64 encoded. --> echo "$CERT" | base64
      - |
        printf '{
            "default": [
              {
                "type": "reject"
              }
            ],
            "transports": {
              "docker": {
                "gcr.io/distroless": [
                  {
                    "type": "sigstoreSigned",
                    "fulcio": {
                      "caData": "LS0tLS1CRUdJTiBDR...QVRFLS0tLS0K",
                      "oidcIssuer": "https://accounts.google.com",
                      "subjectEmail": "keyless@distroless.iam.gserviceaccount.com"
                    },
                    "rekorPublicKeyData": "LS0tLS1CRUdJTiBQVU...lDIEtFWS0tLS0tCg==",
                    "signedIdentity": { "type": "matchRepository" }
                  }
                ]
              },
              "docker-daemon": {
                "": [
                  {
                    "type": "reject"
                  }
                ]
              }
            }
          }' > /etc/containers/policy.json

      # Use this key to sign the built image at push.
      - echo "$SIGSTORE_PRIVATE_KEY" > key.private
      # Login at the registry
      - echo $REGISTRY_LOGIN_TOKEN | podman login -u <username> --password-stdin registry.gitlab.com
      # Build the container image
      - podman build --tag registry.gitlab.com/<namespace>/<repository_name>/<image_name>:latest .
      # Sign and push the image
      - podman push --sign-by-sigstore-private-key ./key.private registry.gitlab.com/<namespace>/<repository_name>/<image_name>:latest

    secrets: [sigstore_private_key, registry_login_token]

```

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

### Example request payload for configuration extension

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/docs/20-usage/72-extensions/40-configuration-extension.md

Example JSON request payload sent to the configuration extension. It includes the repository, pipeline, configuration files, and netrc credentials (when enabled). The netrc field contains credentials to access the repository, which can be used to clone or use the forge API.

```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,
    "enqueued_at": 0,
    "deploy_to": "",
    "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"
  }
}
```

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

### Complex settings example

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/docs/20-usage/51-plugins/20-creating-plugins.md

Shows how to pass complex settings to a plugin. The settings are converted to JSON and passed as an environment variable with a PLUGIN_ prefix. In this example, PLUGIN_COMPLEX would contain {"abc": "2", "list": [ "2", "3" ]}.

```yaml
steps:
  - name: plugin
    image: foo/plugin
    settings:
      complex:
        abc: 2
        list:
          - 2
          - 3
```

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

### Repository structure listing

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/blog/2023-12-15-podman-sigstore/index.md

Shows the expected files in the repository root, including the Containerfile, Go source, and Woodpecker workflow.

```bash
.
├── Containerfile
├── main.go
├── go.mod
├── go.sum
├── .woodpecker.yml
└── Makefile

```

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

### Build Woodpecker server with external web UI

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/docs/92-development/10-packaging.md

Builds the Woodpecker server binary with the web UI served from a custom root path. Requires the 'external_web' build tag and the -X flag to set the webUIRoot variable. The example sets the version to 3.12.0 and uses a Nix store path for the web UI.

```sh
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
```

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

### Strip prefix with CI_COMMIT_TAG

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/docs/20-usage/50-environment.md

Example of using prefix removal to strip the 'v' prefix from a version tag.

```diff
 steps:
   - name: s3
     image: woodpeckerci/plugin-s3
     settings:
+      target: /target/${CI_COMMIT_TAG##v}
```

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

### Test UI code with make test-frontend

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/docs/92-development/01-getting-started.md

Runs the test suite for the UI code.

```bash
make test-frontend
```

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

### Ref condition: tag prefix

Source: https://github.com/woodpecker-ci/woodpecker/blob/main/docs/docs/20-usage/20-workflow-syntax.md

Filters the git reference, e.g., tags that must start with `v`.

```yaml
when:
  - event: tag
    ref: refs/tags/v*
```
Tokens:
Raw