Create Docs for v3.14.0 (#6163)

Co-authored-by: qwerty287 <qwerty287@posteo.de>
This commit is contained in:
6543
2026-05-01 11:01:28 +02:00
committed by GitHub
co-authored by qwerty287
parent f3e3b83e37
commit 9d55d0bf07
94 changed files with 1694 additions and 434 deletions
+1 -1
View File
@@ -255,7 +255,7 @@ Read more about it in [#4213](https://github.com/woodpecker-ci/woodpecker/pull/4
## 1.0.0
- The signature used to verify extension calls (like those used for the [config-extension](/docs/administration/configuration/server#external-configuration-api)) done by the Woodpecker server switched from using a shared-secret HMac to an ed25519 key-pair. Read more about it at the [config-extensions](/docs/administration/configuration/server#external-configuration-api) documentation.
- The signature used to verify extension calls (like those used for the [config-extension](/docs/next/usage/extensions/configuration-extension)) done by the Woodpecker server switched from using a shared-secret HMac to an ed25519 key-pair. Read more about it at the [config-extensions](/docs/next/usage/extensions/configuration-extension) documentation.
- Refactored support for old agent filter labels and expressions. Learn how to use the new [filter](/docs/usage/workflow-syntax#labels)
- Renamed step environment variable `CI_SYSTEM_ARCH` to `CI_SYSTEM_PLATFORM`. Same applies for the cli exec variable.
- Renamed environment variables `CI_BUILD_*` and `CI_PREV_BUILD_*` to `CI_PIPELINE_*` and `CI_PREV_PIPELINE_*`, old ones are still available but deprecated
+2
View File
@@ -33,6 +33,8 @@ Here you can find documentation for previous versions of Woodpecker.
| | | |
| ------- | ---------- | ------------------------------------------------------------------------------------- |
| 3.14.0 | 2026-xx-xx | [Documentation](https://github.com/woodpecker-ci/woodpecker/tree/v3.14.0/docs/docs/) |
| 3.13.0 | 2026-01-14 | [Documentation](https://github.com/woodpecker-ci/woodpecker/tree/v3.13.0/docs/docs/) |
| 3.12.0 | 2025-11-18 | [Documentation](https://github.com/woodpecker-ci/woodpecker/tree/v3.12.0/docs/docs/) |
| 3.11.0 | 2025-10-19 | [Documentation](https://github.com/woodpecker-ci/woodpecker/tree/v3.11.0/docs/docs/) |
| 3.10.0 | 2025-09-28 | [Documentation](https://github.com/woodpecker-ci/woodpecker/tree/v3.10.0/docs/docs/) |
@@ -1,37 +0,0 @@
# Troubleshooting
## How to debug clone issues
(And what to do with an error message like `fatal: could not read Username for 'https://<url>': No such device or address`)
This error can have multiple causes. If you use internal repositories you might have to enable `WOODPECKER_AUTHENTICATE_PUBLIC_REPOS`:
```ini
WOODPECKER_AUTHENTICATE_PUBLIC_REPOS=true
```
If that does not work, try to make sure the container can reach your git server. In order to do that disable git checkout and make the container "hang":
```yaml
skip_clone: true
steps:
build:
image: debian:stable-backports
commands:
- apt update
- apt install -y inetutils-ping wget
- ping -c 4 git.example.com
- wget git.example.com
- sleep 9999999
```
Get the container id using `docker ps` and copy the id from the first column. Enter the container with: `docker exec -it 1234asdf bash` (replace `1234asdf` with the docker id). Then try to clone the git repository with the commands from the failing pipeline:
```bash
git init
git remote add origin https://git.example.com/username/repo.git
git fetch --no-tags origin +refs/heads/branch:
```
(replace the url AND the branch with the correct values, use your username and password as log in values)
@@ -1,48 +0,0 @@
# Architecture
## Package architecture
![Woodpecker architecture](./woodpecker-architecture.png)
## System architecture
### main package hierarchy
| package | meaning | imports |
| ------------------ | -------------------------------------------------------------- | ------------------------------------- |
| `cmd/**` | parse command-line args & environment to stat server/cli/agent | all other |
| `agent/**` | code only agent (remote worker) will need | `pipeline`, `shared` |
| `cli/**` | code only cli tool does need | `pipeline`, `shared`, `woodpecker-go` |
| `server/**` | code only server will need | `pipeline`, `shared` |
| `shared/**` | code shared for all three main tools (go help utils) | only std and external libs |
| `woodpecker-go/**` | go client for server rest api | std |
### Server
| package | meaning | imports |
| -------------------- | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `server/api/**` | handle web requests from `server/router` | `pipeline`, `../badges`, `../ccmenu`, `../logging`, `../model`, `../pubsub`, `../queue`, `../forge`, `../shared`, `../store`, `shared`, (TODO: mv `server/router/middleware/session`) |
| `server/badges/**` | generate svg badges for pipelines | `../model` |
| `server/ccmenu/**` | generate xml ccmenu for pipelines | `../model` |
| `server/grpc/**` | gRPC server agents can connect to | `pipeline/rpc/**`, `../logging`, `../model`, `../pubsub`, `../queue`, `../forge`, `../pipeline`, `../store` |
| `server/logging/**` | logging lib for gPRC server to stream logs while running | std |
| `server/model/**` | structs for store (db) and api (json) | std |
| `server/plugins/**` | plugins for server | `../model`, `../forge` |
| `server/pipeline/**` | orchestrate pipelines | `pipeline`, `../model`, `../pubsub`, `../queue`, `../forge`, `../store`, `../plugins` |
| `server/pubsub/**` | pubsub lib for server to push changes to the WebUI | std |
| `server/queue/**` | queue lib for server where agents pull new pipelines from via gRPC | `server/model` |
| `server/forge/**` | forge lib for server to connect and handle forge specific stuff | `shared`, `server/model` |
| `server/router/**` | handle requests to REST API (and all middleware) and serve UI and WebUI config | `shared`, `../api`, `../model`, `../forge`, `../store`, `../web` |
| `server/store/**` | handle database | `server/model` |
| `server/shared/**` | TODO: move and split [#974](https://github.com/woodpecker-ci/woodpecker/issues/974) | |
| `server/web/**` | server SPA | |
- `../` = `server/`
### Agent
TODO
### CLI
TODO
Binary file not shown.

Before

Width:  |  Height:  |  Size: 61 KiB

@@ -0,0 +1,97 @@
# Troubleshooting
## How to debug clone issues
(And what to do with an error message like `fatal: could not read Username for 'https://<url>': No such device or address`)
This error can have multiple causes. If you use internal repositories you might have to enable `WOODPECKER_AUTHENTICATE_PUBLIC_REPOS`:
```ini
WOODPECKER_AUTHENTICATE_PUBLIC_REPOS=true
```
If that does not work, try to make sure the container can reach your git server. In order to do that disable git checkout and make the container "hang":
```yaml
skip_clone: true
steps:
build:
image: debian:stable-backports
commands:
- apt update
- apt install -y inetutils-ping wget
- ping -c 4 git.example.com
- wget git.example.com
- sleep 9999999
```
Get the container id using `docker ps` and copy the id from the first column. Enter the container with: `docker exec -it 1234asdf bash` (replace `1234asdf` with the docker id). Then try to clone the git repository with the commands from the failing pipeline:
```bash
git init
git remote add origin https://git.example.com/username/repo.git
git fetch --no-tags origin +refs/heads/branch:
```
(replace the url AND the branch with the correct values, use your username and password as log in values)
## SELinux Issues
When running Woodpecker on systems with SELinux enabled (such as RHEL, CentOS, Fedora, or other Enterprise Linux distributions), SELinux may prevent the agent from accessing the Docker socket.
### Symptoms
If SELinux is blocking access, you may see errors like:
```text
permission denied while trying to connect to the Docker daemon socket at unix:///var/run/docker.sock
```
### Solutions
There are several ways to resolve this:
#### Option 1: Set SELinux to Permissive Mode (For Testing Only)
Set SELinux to permissive mode temporarily to verify it's the issue:
```bash
setenforce 0
```
To permanently set SELinux to permissive mode:
```bash
# Edit /etc/selinux/config
SELINUX=permissive
```
#### Option 2: Configure SELinux Policy (Recommended)
Create a custom SELinux policy to allow Woodpecker agent to access Docker:
```bash
# Generate the policy module
ausearch -c 'docker' -avc | audit2allow -R -o woodpecker-docker.te
# Build the policy module
checkmodule -M -m -o woodpecker-docker.mod woodpecker-docker.te
semodule_package -o woodpecker-docker.pp -m woodpecker-docker.mod
# Load the policy module
semodule -i woodpecker-docker.pp
```
#### Option 3: Use Docker Volume with SELinux Options
When using Docker Compose or Docker, add the `:z` or `:Z` option to volume mounts:
```yaml
volumes:
- /var/run/docker.sock:/var/run/docker.sock:z
```
The `:z` option tells Docker to automatically relabel the volume content for SELinux. Use `:Z` with caution as it relabels the volume exclusively for this container.
#### Option 4: Use Podman (Alternative)
If you prefer to avoid SELinux configuration issues, consider using Podman instead of Docker, as it has better SELinux integration.

Before

Width:  |  Height:  |  Size: 31 KiB

After

Width:  |  Height:  |  Size: 31 KiB

@@ -2,29 +2,29 @@
## Glossary
- **Woodpecker CI**: The project name around Woodpecker.
- **Woodpecker**: An open-source tool that executes [pipelines][Pipeline] on your code.
- **Server**: The component of Woodpecker that handles webhooks from forges, orchestrates agents, and sends status back. It also serves the API and web UI for administration and configuration.
- **Agent**: A component of Woodpecker that executes [pipelines][Pipeline] (specifically one or more [workflows][Workflow]) with a specific backend (e.g. [Docker][], Kubernetes, [local][Local]). It connects to the server via GRPC.
- **CLI**: The Woodpecker command-line interface (CLI) is a terminal tool used to administer the server, to execute pipelines locally for debugging / testing purposes, and to perform tasks like linting pipelines.
- **[Pipeline][Pipeline]**: A sequence of [workflows][Workflow] that are executed on the code. Pipelines are triggered by events.
- **[Workflow][Workflow]**: A sequence of steps and services that are executed as part of a [pipeline][Pipeline]. Workflows are represented by YAML files. Each workflow has its own isolated [workspace][Workspace], and often additional resources like a shared network (docker).
- **Steps**: Individual commands, actions or tasks within a [workflow][Workflow].
- **Code**: Refers to the files tracked by the version control system used by the [forge][Forge].
- **Repos**: Short for repositories, these are storage locations where code is stored.
- **[Forge][Forge]**: The hosting platform or service where the repositories are hosted.
- **[Workspace][workspace]**: A folder shared between all steps of a [workflow][Workflow] containing the repository and all the generated data from previous steps.
- **[Event][Event]**: Triggers the execution of a [pipeline][Pipeline], such as a [forge][Forge] event like `push`, or `manual` triggered manually from the UI.
- **Commit**: A defined state of the code, usually associated with a version control system like Git.
- **[Matrix][Matrix]**: A configuration option that allows the execution of [workflows][Workflow] for each value in the matrix.
- **Service**: A service is a step that is executed from the start of a [workflow][Workflow] until its end. It can be accessed by name via the network from other steps within the same [workflow][Workflow].
- **[Plugins][Plugin]**: Plugins are extensions that provide pre-defined actions or commands for a step in a [workflow][Workflow]. They can be configured via settings.
- **Container**: A lightweight and isolated environment where commands are executed.
- **YAML File**: A file format used to define and configure [workflows][Workflow].
- **Dependency**: [Workflows][Workflow] can depend on each other, and if possible, they are executed in parallel.
- **[Event][Event]**: Triggers the execution of a [pipeline][Pipeline], such as a [forge][Forge] event like `push`, or `manual` triggered manually from the UI.
- **[Extension][Extension]**: Some parts of Woodpecker internal services like secrets storage or config fetcher can be replaced through extensions.
- **[Forge][Forge]**: The hosting platform or service where the repositories are hosted.
- **[Matrix][Matrix]**: A configuration option that allows the execution of [workflows][Workflow] for each value in the matrix.
- **[Pipeline][Pipeline]**: A sequence of [workflows][Workflow] that are executed on the code. Pipelines are triggered by events.
- **[Plugins][Plugin]**: Plugins are extensions that provide pre-defined actions or commands for a step in a [workflow][Workflow]. They can be configured via settings.
- **Repos**: Short for repositories, these are storage locations where code is stored.
- **Server**: The component of Woodpecker that handles webhooks from forges, orchestrates agents, and sends status back. It also serves the API and web UI for administration and configuration.
- **Service**: A service is a step that is executed from the start of a [workflow][Workflow] until its end. It can be accessed by name via the network from other steps within the same [workflow][Workflow].
- **Status**: Status refers to the outcome of a step or [workflow][Workflow] after it has been executed, determined by the internal command exit code. At the end of a [workflow][Workflow], its status is sent to the [forge][Forge].
- **Service extension**: Some parts of Woodpecker internal services like secrets storage or config fetcher can be replaced through service extensions.
- **Steps**: Individual commands, actions or tasks within a [workflow][Workflow].
- **Task**: A task is a [workflow][Workflow] that's currently waiting for its execution in the task queue.
- **Woodpecker**: An open-source tool that executes [pipelines][Pipeline] on your code.
- **Woodpecker CI**: The project name around Woodpecker.
- **[Workflow][Workflow]**: A sequence of steps and services that are executed as part of a [pipeline][Pipeline]. Workflows are represented by YAML files. Each workflow has its own isolated [workspace][Workspace], and often additional resources like a shared network (docker).
- **[Workspace][workspace]**: A folder shared between all steps of a [workflow][Workflow] containing the repository and all the generated data from previous steps.
- **YAML File**: A file format used to define and configure [workflows][Workflow].
## Woodpecker architecture
@@ -54,3 +54,4 @@ Sometimes there are multiple terms that can be used to describe something. This
[Matrix]: ../30-matrix-workflows.md
[Docker]: ../../30-administration/10-configuration/11-backends/10-docker.md
[Local]: ../../30-administration/10-configuration/11-backends/30-local.md
[Extension]: ../72-extensions/index.md
@@ -196,6 +196,8 @@ Some of the steps may be allowed to fail without causing the whole workflow and
+ failure: ignore
```
If you would like to cancel the full pipeline once the step fails, you can set `failure: cancel`.
### `when` - Conditional Execution
Woodpecker supports defining a list of conditions for a step by using a `when` block. If at least one of the conditions in the `when` block evaluate to true the step is executed, otherwise it is skipped. A condition is evaluated to true if _all_ sub-conditions are true.
@@ -340,7 +342,14 @@ when:
#### `status`
There are use cases for executing steps on failure, such as sending notifications for failed workflow/pipeline. Use the status constraint to execute steps even when the workflow fails:
By default, steps only run when the workflow has succeeded up to that point,<br>
which is equivalent to `status: [ success ]`.
The `status` filter lets you override this behavior.
The only accepted values are `success` and `failure`.
A common use case is executing a step on failure, such as sending notifications for a failed workflow/pipeline.
To run a step regardless of outcome, list both values:
```diff
steps:
@@ -350,6 +359,18 @@ There are use cases for executing steps on failure, such as sending notification
+ - status: [ success, failure ]
```
The filter is aware of the other filters. If you want to run on failures if the event is `tag`, but if it's a `pull_request`, run it on both success and failure:
```diff
when:
+ - event: tag
+ status: [ failure ]
+ - event: pull_request
+ status: [ success, failure ]
```
If there's no matching filter at all or all matching filters don't have set `status`, it will use the default, which means it runs on success only. In the example above this will happen if the event is neither `tag` nor `pull_request`.
#### `platform`
:::note
@@ -393,7 +414,7 @@ when:
#### `path`
:::info
Path conditions are applied only to **push** and **pull_request** events. This feature is currently available for all forges except Bitbucket Cloud.
Path conditions are applied only to **push** and **pull_request** events.
:::
Execute a step only on a pipeline with certain files being changed:
@@ -761,10 +782,6 @@ The workflow now triggers on `main`, but also if the target branch of a pull req
Woodpecker supports to define multiple workflows for a repository. Those workflows will run independent from each other. To depend them on each other you can use the [`depends_on`](./25-workflows.md#flow-control) keyword.
## `runs_on`
Workflows that should run even on failure should set the `runs_on` tag. See [here](./25-workflows.md#flow-control) for an example.
## Advanced network options for steps
:::warning
@@ -97,7 +97,7 @@ The name for a `depends_on` entry is the filename without the path, leading dots
+ - test
```
Workflows that need to run even on failures should set the `runs_on` tag.
Workflows that need to run even on failures should set the `status` filter.
```diff
steps:
@@ -109,9 +109,12 @@ Workflows that need to run even on failures should set the `runs_on` tag.
depends_on:
- deploy
+runs_on: [ success, failure ]
+when:
+ - status: [ success, failure ]
```
This works just like the [`status` filter for steps](./20-workflow-syntax.md#status).
:::info
Some workflows don't need the source code, like creating a notification on failure.
Read more about `skip_clone` at [pipeline syntax](./20-workflow-syntax.md#skip_clone)
@@ -106,7 +106,7 @@ woodpecker-cli repo secret add \
Create the secret and limit it to a single image:
```diff
woodpecker-cli repo secret add \
woodpecker-cli secret add \
--repository octocat/hello-world \
+ --image woodpeckerci/plugin-s3 \
--name aws_access_key_id \
@@ -37,6 +37,20 @@ services:
- 51820/udp
```
## Stopping
Services that are no longer needed receive a **SIGTERM** signal. If they do not respond, they are forcibly terminated with **SIGKILL**.
If there are services that do not shut down properly and this doesn't matter, you can simply ignore the error:
```diff
services:
- name: database
image: mysql
+ failure: ignore # we don't care how mysql exits
ports:
- 3306
```
## Configuration
Service containers generally expose environment variables to customize service startup such as default usernames, passwords and ports. Please see the official image documentation to learn more.
@@ -23,26 +23,33 @@ As Woodpecker will pass private information like tokens and will execute the ret
In addition to the ability to configure the extension per repository, you can also configure a global endpoint in the Woodpecker server configuration. This can be useful if you want to use the extension for all repositories. Be careful if
you share your Woodpecker server with others as they will also use your configuration extension.
The global configuration will be called before the repository specific configuration extension if both are configured.
The global configuration will be called before the repository specific configuration extension if both are configured and the repository has not enabled the exclusive setting.
```ini title="Server"
WOODPECKER_CONFIG_SERVICE_ENDPOINT=https://example.com/ciconfig
WOODPECKER_CONFIG_EXTENSION_ENDPOINT=https://example.com/ciconfig
```
## How it works
When a pipeline is triggered Woodpecker will fetch the pipeline configuration from the repository, then make a HTTP POST request to the configured extension with a JSON payload containing some data like the repository, pipeline information and the current config files retrieved from the repository. The extension can then send back modified or even new pipeline configurations following Woodpeckers official yaml format that should be used.
You can enable the exclusive setting (both globally and on a per-repo level). Then Woodpecker will only call your extension, but nothing else. This allows you to completely skip the forge. Requests sent to the extension will not have the configuration files added.
### Request
The extension receives an HTTP POST request with the following JSON payload:
:::info
The `netrc` field is only included in the request when the global `WOODPECKER_CONFIG_EXTENSION_NETRC` is set to `true` (default: `false`) or the per-repo "Send netrc credentials" is checked.
:::
```ts
class Request {
repo: Repo;
pipeline: Pipeline;
netrc: Netrc;
configuration: {
netrc?: Netrc; // only included when netrc sending is enabled (see above)
configuration?: {
// list of configurations. Not send if there was none.
name: string; // filename of the configuration file
data: string; // content of the configuration file
}[];
@@ -123,12 +130,17 @@ Example request:
"updated_at": 0,
"verified": false
},
"configs": [
"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"
}
}
```
@@ -0,0 +1,160 @@
# Registry extension
Woodpecker uses the registry extension to get registry credentials. You can configure an HTTP endpoint in the repository settings in the extensions tab.
Using such an extension can be useful if you want to:
- Centralize registry credential management
- Use an external storage for credentials
- Dynamically manage which credentials Woodpecker should use
## Security
:::warning
As Woodpecker will pass private information like tokens and will execute the returned configuration, it is extremely important to secure the external extension. Therefore Woodpecker signs every request. Read more about it in the [security section](./index.md#security).
:::
## Global configuration
In addition to the ability to configure the extension per repository, you can also configure a global endpoint in the Woodpecker server configuration. This can be useful if you want to use the extension for all repositories. Be careful if
you share your Woodpecker server with others as they will also use your registry extension.
If both the global and the repo-level extension return credentials for a registry, it will use the credentials from the repo extension.
```ini title="Server"
WOODPECKER_REGISTRY_EXTENSION_ENDPOINT=https://example.com/ciconfig
```
## How it works
When a pipeline is triggered, Woodpecker will fetch the credentials from your service. As fallback, it uses the credentials configured directly in Woodpecker.
### Request
The extension receives an HTTP POST request with the following JSON payload:
:::info
The `netrc` field is only included in the request when the global `WOODPECKER_REGISTRY_EXTENSION_NETRC` is set to `true` (default: `false`) or the per-repo "Send netrc credentials" is checked.
:::
```ts
class Request {
repo: Repo;
pipeline: Pipeline;
netrc?: Netrc; // only included when netrc sending is enabled (see above)
}
```
Checkout the following models for more information:
- [repo model](https://github.com/woodpecker-ci/woodpecker/blob/main/server/model/repo.go)
- [pipeline model](https://github.com/woodpecker-ci/woodpecker/blob/main/server/model/pipeline.go)
- [netrc model](https://github.com/woodpecker-ci/woodpecker/blob/main/server/model/netrc.go)
:::tip
The `netrc` data is pretty powerful as it contains credentials to access the repository. You can use this to clone the repository or even use the forge (Github or Gitlab, ...) API to get more information about the repository.
:::
Example request:
```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"
}
}
```
### Response
The extension should respond with a JSON payload containing the new configuration files in Woodpecker's official YAML format.
If the extension wants to keep the existing configuration files, it can respond with HTTP status `204 No Content`.
```ts
class Response {
registries: {
address: string; // the docker registry address
username: string; // registry username
password: string; // registry password
}[];
}
```
Example response:
```json
{
"registries": [
{
"address": "docker.io",
"username": "woodpecker-bot",
"password": "your-pass-word-123"
}
]
}
```
@@ -0,0 +1,166 @@
# Secret extension
Woodpecker uses the secret extension to get secrets from an external service. You can configure an HTTP endpoint in the repository settings in the extensions tab.
Using such an extension can be useful if you want to:
- Centralize secret management (e.g. HashiCorp Vault, AWS Secrets Manager)
- Dynamically generate secrets per pipeline
## Security
:::warning
As Woodpecker will pass private information like tokens and will execute the returned configuration, it is extremely important to secure the external extension. Therefore Woodpecker signs every request. Read more about it in the security section.
:::
## Global configuration
In addition to the ability to configure the extension per repository, you can also configure a global endpoint in the Woodpecker server configuration. This can be useful if you want to use the extension for all repositories. Be careful if
you share your Woodpecker server with others as they will also use your secret extension.
If both the global and the repo-level extension return a secret with the same name, it will use the secret from the repo extension.
```ini title="Server"
WOODPECKER_SECRET_EXTENSION_ENDPOINT=https://example.com/secrets
WOODPECKER_SECRET_EXTENSION_NETRC=false
```
## How it works
When a pipeline is triggered, Woodpecker will fetch secrets from your service. The extension secrets are merged with the secrets configured directly in Woodpecker, with extension secrets taking priority by name. If the extension is unavailable, Woodpecker falls back to the locally configured secrets.
### Request
The extension receives an HTTP POST request with the following JSON payload:
:::info
The `netrc` field is only included in the request when the global `WOODPECKER_SECRET_EXTENSION_NETRC` is set to `true` (default: `false`) or the per-repo "Send netrc credentials" is checked.
:::
```ts
class Request {
repo: Repo;
pipeline: Pipeline;
netrc?: Netrc; // only included when netrc sending is enabled (see above)
}
```
Checkout the following models for more information:
- [repo model](https://github.com/woodpecker-ci/woodpecker/blob/main/server/model/repo.go)
- [pipeline model](https://github.com/woodpecker-ci/woodpecker/blob/main/server/model/pipeline.go)
- [netrc model](https://github.com/woodpecker-ci/woodpecker/blob/main/server/model/netrc.go)
:::tip
The `netrc` data is pretty powerful as it contains credentials to access the repository. You can use this to clone the repository or even use the forge (Github or Gitlab, ...) API to get more information about the repository.
:::
Example request:
```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.
```
### Response
The extension should respond with a JSON object containing a `secrets` array.
If the extension wants to keep the existing secrets without adding any, it can respond with HTTP status `204 No Content`.
```ts
class Response {
secrets: {
name: string; // the secret name, matched by from_secret in pipeline config
value: string; // the secret value
images?: string[]; // optional: restrict to specific plugins
events?: string[]; // optional: restrict to specific pipeline events
}[];
}
```
Example response:
```json
{
"secrets": [
{
"name": "docker_password",
"value": "your-secret-password-123"
},
{
"name": "deploy_token",
"value": "super-secret-token",
"events": ["push", "tag"]
}
]
}
```
@@ -5,6 +5,8 @@ Woodpecker allows you to replace internal logic with external extensions by usin
There is currently one type of extension available:
- [Configuration extension](./40-configuration-extension.md) to modify or generate pipeline configurations on the fly.
- [Registry extension](./50-registry-extension.md) to get registry credentials from the extension.
- [Secret extension](./55-secret-extension.md) to get secrets from an external service.
## Security
@@ -15,4 +15,10 @@ The status badge displays the status for the latest build to your default branch
+<scheme>://<hostname>/api/badges/<repo-id>/status.svg?branch=<branch>
```
Please note status badges do not include pull request results, since the status of a pull request does not provide an accurate representation of your repository state.
By default status badges do not include pull request results, since the status of a pull request does not provide an accurate representation of your repository state.
If you'd like to respect other or further events, you can add the `events` query parameter, otherwise the badge represents only the state of the last push event:
```diff
-<scheme>://<hostname>/api/badges/<repo-id>/status.svg
+<scheme>://<hostname>/api/badges/<repo-id>/status.svg?events=manual,cron
```

Before

Width:  |  Height:  |  Size: 40 KiB

After

Width:  |  Height:  |  Size: 40 KiB

Before

Width:  |  Height:  |  Size: 113 KiB

After

Width:  |  Height:  |  Size: 113 KiB

Before

Width:  |  Height:  |  Size: 430 KiB

After

Width:  |  Height:  |  Size: 430 KiB

Before

Width:  |  Height:  |  Size: 353 KiB

After

Width:  |  Height:  |  Size: 353 KiB

Before

Width:  |  Height:  |  Size: 351 KiB

After

Width:  |  Height:  |  Size: 351 KiB

Before

Width:  |  Height:  |  Size: 29 KiB

After

Width:  |  Height:  |  Size: 29 KiB

@@ -140,3 +140,14 @@ To store values in a docker secret you can use the following command:
```bash
echo "my_agent_secret_key" | docker secret create woodpecker-agent-secret -
```
## SELinux Considerations
If you're running Woodpecker on a system with SELinux enabled (RHEL, CentOS, Fedora, etc.), you may need to add the `:z` or `:Z` option to volume mounts. For the Docker socket volume:
```yaml
volumes:
- /var/run/docker.sock:/var/run/docker.sock:z
```
For more details and other SELinux-related solutions, see the [Troubleshooting](../../20-usage/100-troubleshooting.md#selinux-issues) page.
@@ -3,8 +3,7 @@
Woodpecker provides a [Helm chart](https://github.com/woodpecker-ci/helm) for Kubernetes environments:
```bash
helm repo add woodpecker oci://ghcr.io/woodpecker-ci/helm
helm install woodpecker woodpecker/woodpecker
helm install woodpecker oci://ghcr.io/woodpecker-ci/helm/woodpecker --version <VERSION>
```
## Metrics
@@ -92,6 +92,7 @@ Woodpecker itself is not responsible for creating these packages. Please reach o
- [YunoHost](https://apps.yunohost.org/app/woodpecker)
- [Cloudron](https://www.cloudron.io/store/org.woodpecker_ci.cloudronapp.html)
- [Easypanel](https://easypanel.io/docs/templates/woodpeckerci)
- [Homebrew](https://formulae.brew.sh/formula/woodpecker-cli) (CLI only)
### NixOS
@@ -402,97 +402,6 @@ woodpecker_waiting_steps 0
woodpecker_worker_count 4
```
## External Configuration API
To provide additional management and preprocessing capabilities for pipeline configurations Woodpecker supports an HTTP API which can be enabled to call an external config service.
Before the run or restart of any pipeline Woodpecker will make a POST request to an external HTTP API sending the current repository, build information and all current config files retrieved from the repository. The external API can then send back new pipeline configurations that will be used immediately or respond with `HTTP 204` to tell the system to use the existing configuration.
Every request sent by Woodpecker is signed using a [http-signature](https://datatracker.ietf.org/doc/html/rfc9421) by a private key (ed25519) generated on the first start of the Woodpecker server. You can get the public key for the verification of the http-signature from `http(s)://your-woodpecker-server/api/signature/public-key`.
A simplistic example configuration service can be found here: [https://github.com/woodpecker-ci/example-config-service](https://github.com/woodpecker-ci/example-config-service)
:::warning
You need to trust the external config service as it is getting secret information about the repository and pipeline and has the ability to change pipeline configs that could run malicious tasks.
:::
### Configuration
```ini title="Server"
WOODPECKER_CONFIG_SERVICE_ENDPOINT=https://example.com/ciconfig
```
#### Example request made by Woodpecker
```json
{
"repo": {
"id": 100,
"uid": "",
"user_id": 0,
"namespace": "",
"name": "woodpecker-test-pipe",
"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-file-name.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": "https://example.com",
"login": "user",
"password": "password"
}
}
```
#### Example response structure
```json
@@ -1062,12 +971,82 @@ Supported variables:
---
### CONFIG_SERVICE_ENDPOINT
### CONFIG_EXTENSION_ENDPOINT
- Name: `WOODPECKER_CONFIG_SERVICE_ENDPOINT`
- Name: `WOODPECKER_CONFIG_EXTENSION_ENDPOINT`
- Default: none
Specify a configuration service endpoint, see [Configuration Extension](#external-configuration-api)
Specify a configuration extension endpoint, see [Configuration Extension](../../20-usage/72-extensions/40-configuration-extension.md)
---
### CONFIG_EXTENSION_EXCLUSIVE
- Name: `CONFIG_EXTENSION_EXCLUSIVE`
- Default: false
Whether the forge request should be skipped for the global configuration endpoint.
:::warning
If you enable this, all repos will exclusively use the global config service endpoint. There is no possibility to directly define pipelines in the forge, except the extension handles this case itself as well.
:::
---
### CONFIG_EXTENSION_NETRC
- Name: `WOODPECKER_CONFIG_EXTENSION_NETRC`
- Default: false
Send `netrc` to the config extension endpoint.
:::warning
The `netrc` data is pretty powerful as it contains credentials to access the repository. You can use this to clone the repository or even use the forge API to get more information about the repository.
:::
---
### SECRET_EXTENSION_ENDPOINT
- Name: `WOODPECKER_SECRET_EXTENSION_ENDPOINT`
- Default: none
Specify a secret extension endpoint, see [Secret Extension](../../20-usage/72-extensions/55-secret-extension.md)
---
### SECRET_EXTENSION_NETRC
- Name: `WOODPECKER_SECRET_EXTENSION_NETRC`
- Default: false
Send `netrc` to the secret extension endpoint.
:::warning
The `netrc` data is pretty powerful as it contains credentials to access the repository. You can use this to clone the repository or even use the forge API to get more information about the repository.
:::
---
### REGISTRY_EXTENSION_ENDPOINT
- Name: `WOODPECKER_REGISTRY_EXTENSION_ENDPOINT`
- Default: none
Specify a registry extension endpoint, see [Registry Extension](../../20-usage/72-extensions/50-registry-extension.md)
---
### REGISTRY_EXTENSION_NETRC
- Name: `WOODPECKER_REGISTRY_EXTENSION_NETRC`
- Default: false
Send `netrc` to the registry extension endpoint.
:::warning
The `netrc` data is pretty powerful as it contains credentials to access the repository. You can use this to clone the repository or even use the forge API to get more information about the repository.
:::
---
@@ -1121,7 +1100,11 @@ Disable version check in admin web UI.
- Name: `WOODPECKER_LOG_STORE`
- Default: `database`
Where to store logs. Possible values: `database` or `file`.
Where to store logs. Possible values:
- `database`: stores the logs in the database
- `file`: stores logs in JSON files on the files system
- `addon`: uses an [addon](./100-addons.md#log) to store logs
---
@@ -1130,7 +1113,10 @@ Where to store logs. Possible values: `database` or `file`.
- Name: `WOODPECKER_LOG_STORE_FILE_PATH`
- Default: none
Directory to store logs in if [`WOODPECKER_LOG_STORE`](#log_store) is `file`.
If [`WOODPECKER_LOG_STORE`](#log_store) is:
- `file`: Directory to store logs in
- `addon`: The path to the addon executable
---
@@ -1160,6 +1146,19 @@ Fully qualified public forge URL, used if forge url is not a public URL. Format:
---
### FORCE_IGNORE_SERVICE_FAILURE
- Name: `WOODPECKER_FORCE_IGNORE_SERVICE_FAILURE`
- Default: true
:::warning
Since v3.14.0, Woodpecker can report the status of services and detached steps.
Because these can now fail, until v4.0.0 is released, service failures are ignored by default to preserve backward compatibility.
We encourage you to disable this option and update your pipeline configuration.
:::
---
### GITHUB\_\*
See [GitHub configuration](./12-forges/20-github.md#configuration)
@@ -0,0 +1,42 @@
# Addons
Addons can be used to extend the Woodpecker server. Currently, they can be used for forges and the log service.
:::warning
Addon forges are still experimental. Their implementation can change and break at any time.
:::
:::danger
You must trust the author of the addon forge you are using. They may have access to authentication codes and other potentially sensitive information.
:::
## Usage
To use an addon forge, download the correct addon version.
### Forge
Use this in your `.env`:
```ini
WOODPECKER_ADDON_FORGE=/path/to/your/addon/forge/file
```
In case you run Woodpecker as container, you probably want to mount the addon binary to `/opt/addons/`.
#### List of addon forges
- [Radicle](https://radicle.xyz/): Open source, peer-to-peer code collaboration stack built on Git. Radicle addon for Woodpecker CI can be found at [this repo](https://explorer.radicle.gr/nodes/seed.radicle.gr/rad:z39Cf1XzrvCLRZZJRUZnx9D1fj5ws).
### Log
Use this in your `.env`:
```ini
WOODPECKER_LOG_STORE=addon
WOODPECKER_LOG_STORE_FILE_PATH=/path/to/your/addon/forge/file
```
## Developing addon forges
See [Addons](../../92-development/100-addons.md).
@@ -145,6 +145,100 @@ steps:
value: 'value1'
effect: 'NoSchedule'
tolerationSeconds: 3600
affinity:
nodeAffinity:
requiredDuringSchedulingIgnoredDuringExecution:
nodeSelectorTerms:
- matchExpressions:
- key: topology.kubernetes.io/zone
operator: In
values:
- eu-central-1a
- eu-central-1b
```
### Affinity
Kubernetes [affinity and anti-affinity](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#affinity-and-anti-affinity) rules allow you to constrain which nodes your pods can be scheduled on based on node labels, or co-locate/spread pods relative to other pods.
You can configure affinity at two levels:
1. **Per-step via `backend_options.kubernetes.affinity`** (shown in example above) - requires agent configuration to allow it
2. **Agent-wide via `WOODPECKER_BACKEND_K8S_POD_AFFINITY`** - applies to all pods unless overridden
#### Agent-wide affinity
To apply affinity rules to all workflow pods, configure the agent with YAML-formatted affinity:
```yaml
WOODPECKER_BACKEND_K8S_POD_AFFINITY: |
nodeAffinity:
requiredDuringSchedulingIgnoredDuringExecution:
nodeSelectorTerms:
- matchExpressions:
- key: node-role.kubernetes.io/worker
operator: In
values:
- "true"
```
By default, per-step affinity settings are **not allowed** for security reasons. To enable them:
```bash
WOODPECKER_BACKEND_K8S_POD_AFFINITY_ALLOW_FROM_STEP: true
```
:::warning
Enabling `WOODPECKER_BACKEND_K8S_POD_AFFINITY_ALLOW_FROM_STEP` in multi-tenant environments allows pipeline authors to control pod placement, which may have security or resource isolation implications.
:::
When per-step affinity is allowed and specified, it **replaces** the agent-wide affinity entirely (not merged).
#### Example: agent affinity for co-location
This example configures all workflow pods within a workflow to be co-located on the same node, while requiring other workflows run on different nodes.
It uses `matchLabelKeys` to dynamically match pods with the same `woodpecker-ci.org/task-uuid`, and `mismatchLabelKeys` to separating pods with different task UUIDs:
```yaml
WOODPECKER_BACKEND_K8S_POD_AFFINITY: |
podAffinity:
requiredDuringSchedulingIgnoredDuringExecution:
- labelSelector: {}
matchLabelKeys:
- woodpecker-ci.org/task-uuid
topologyKey: "kubernetes.io/hostname"
podAntiAffinity:
requiredDuringSchedulingIgnoredDuringExecution:
- labelSelector: {}
mismatchLabelKeys:
- woodpecker-ci.org/task-uuid
topologyKey: "kubernetes.io/hostname"
```
:::note
The `matchLabelKeys` and `mismatchLabelKeys` features require Kubernetes v1.29+ (alpha with feature gate `MatchLabelKeysInPodAffinity`) or v1.33+ (beta, enabled by default). These fields allow the Kubernetes API server to dynamically populate label selectors at pod creation time, eliminating the need to hardcode values like `$(WOODPECKER_TASK_UUID)`.
:::
#### Example: Node affinity for GPU workloads
Ensure a step runs only on GPU-enabled nodes:
```yaml
steps:
- name: train-model
image: tensorflow/tensorflow:latest-gpu
backend_options:
kubernetes:
affinity:
nodeAffinity:
requiredDuringSchedulingIgnoredDuringExecution:
nodeSelectorTerms:
- matchExpressions:
- key: accelerator
operator: In
values:
- nvidia-tesla-v100
```
### Volumes
@@ -153,7 +247,7 @@ To mount volumes a PersistentVolume (PV) and PersistentVolumeClaim (PVC) are nee
Persistent volumes must be created manually. Use the Kubernetes [Persistent Volumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) documentation as a reference.
_If your PVC is not highly available or NFS-based, you may also need to integrate affinity settings to ensure that your steps are executed on the correct node._
_If your PVC is not highly available or NFS-based, use the `affinity` settings (documented above) to ensure that your steps are executed on the correct node._
NOTE: If you plan to use this volume in more than one workflow concurrently, make sure you have configured the PVC in `RWX` mode. Keep in mind that this feature must be supported by the used CSI driver:
@@ -265,6 +359,26 @@ backend_options:
The feature requires Kubernetes v1.30 or above.
:::
You can set `allowPrivilegeEscalation` to `false` to prevent a container from gaining more privileges than its parent process.
```yaml
backend_options:
kubernetes:
securityContext:
allowPrivilegeEscalation: false
```
You can also drop [Linux capabilities](https://man7.org/linux/man-pages/man7/capabilities.7.html) from a container. Adding capabilities is not allowed.
```yaml
backend_options:
kubernetes:
securityContext:
capabilities:
drop:
- ALL
```
### Annotations and labels
You can specify arbitrary [annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) and [labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) to be set on the Pod definition for a given workflow step using the following configuration:
@@ -304,6 +418,36 @@ It configures the address of the Kubernetes API server to connect to.
If running the agent within Kubernetes, this will already be set and you don't have to add it manually.
### Headless services
For each workflow run a [headless services](https://kubernetes.io/docs/concepts/services-networking/service/#headless-services) is created,
and all steps asigned the subdomain that matches the headless service, so any step can reach other steps via DNS by using the step name as hostname.
Using the headless services, the step pod is connected to directly, so any port on the other step pods can be reached.
This is useful for some use-cases, like test-containers in a docker-in-docker setup, where the step needs to connect to many ports on the docker host service.
```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
detached: true
privileged: true
environment:
DOCKER_TLS_CERTDIR: /woodpecker/dind-certs
```
If ports are defined on a service, then woodpecker will create a normal service for the pod, which use hosts override using the services cluster IP.
## Environment variables
These env vars can be set in the `env:` sections of the agent.
@@ -11,6 +11,8 @@
| Event: Deploy¹ | :white_check_mark: | :x: | :x: | :x: | :x: | :x: |
| [Event: Pull-Request-Metadata](../../../20-usage/50-environment.md#pull_request_metadata-specific-event-reason-values) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :x: | :x: |
| [Multiple workflows](../../../20-usage/25-workflows.md) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| [when.path filter](../../../20-usage/20-workflow-syntax.md#path) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :x: | :white_check_mark: |
| [when.path filter](../../../20-usage/20-workflow-syntax.md#path) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
¹ The deployment event can be triggered for all forges from Woodpecker directly. However, only GitHub can trigger them using webhooks.
In addition to this, Woodpecker supports [addon forges](../100-addons.md) if the forge you are using does not meet the [Woodpecker requirements](../../../92-development/02-core-ideas.md#forges) or your setup is too specific to be included in the Woodpecker core.
@@ -33,8 +33,29 @@ To configure the Docker network if the network's name is `gitea`, configure it l
## Registration
### User OAuth Application
Register your application with Gitea to create your client id and secret. You can find the OAuth applications settings of Gitea at `https://gitea.<host>/user/settings/`. It is very important that authorization callback URL matches your http(s) scheme and hostname exactly with `https://<host>/authorize` as the path.
### System-wide OAuth Application
If you are the administrator of both Gitea and Woodpecker, you may prefer to use a system-wide OAuth application instead of a user-level application. System-wide applications are managed at the Gitea site administrator level and are visible to all users.
To create a system-wide OAuth application in Gitea:
1. Navigate to the site administration settings at `https://gitea.<host>/admin/settings/applications`
2. Create a new OAuth2 application under the "OAuth2 Applications" section
3. Configure the application with the same settings as above (callback URL, etc.)
4. Use the generated client id and secret for Woodpecker configuration
System-wide applications are particularly useful for:
- Shared CI/CD environments where multiple users need Woodpecker access
- Organizations that want centralized control over OAuth applications
- Preventing user-level application quotas from affecting CI/CD operations
### Local Connections
If you run the Woodpecker CI server on the same host as the Gitea instance, you might also need to allow local connections in Gitea, since version `v1.16`. Otherwise webhooks will fail. Add the following lines to your Gitea configuration (usually at `/etc/gitea/conf/app.ini`).
```ini
@@ -33,8 +33,29 @@ To configure the Docker network if the network's name is `forgejo`, configure it
## Registration
### User OAuth Application
Register your application with Forgejo to create your client id and secret. You can find the OAuth applications settings of Forgejo at `https://forgejo.<host>/user/settings/`. It is very important that authorization callback URL matches your http(s) scheme and hostname exactly with `https://<host>/authorize` as the path.
### System-wide OAuth Application
If you are the administrator of both Forgejo and Woodpecker, you may prefer to use a system-wide OAuth application instead of a user-level application. System-wide applications are managed at the Forgejo site administrator level and are visible to all users.
To create a system-wide OAuth application in Forgejo:
1. Navigate to the site administration settings at `https://forgejo.<host>/admin/settings/applications`
2. Create a new OAuth2 application under the "OAuth2 Applications" section
3. Configure the application with the same settings as above (callback URL, etc.)
4. Use the generated client id and secret for Woodpecker configuration
System-wide applications are particularly useful for:
- Shared CI/CD environments where multiple users need Woodpecker access
- Organizations that want centralized control over OAuth applications
- Preventing user-level application quotas from affecting CI/CD operations
### Local Connections
If you run the Woodpecker CI server on the same host as the Forgejo instance, you might also need to allow local connections in Forgejo. Otherwise webhooks will fail. Add the following lines to your Forgejo configuration (usually at `/etc/forgejo/conf/app.ini`).
```ini
@@ -148,6 +148,19 @@ Configures the number of parallel workflows.
---
### AGENT_SINGLE_WORKFLOW
- Name: `WOODPECKER_AGENT_SINGLE_WORKFLOW`
- Default: `false`
Configures the agent to exit (shutdown) after executing one workflow. When configured,
`WOODPECKER_MAX_WORKFLOWS` is forced to 1.
This one-shot mode is useful in ephemeral environments that are provisioned on demand
by external automation — for example, when an autoscaler spins up a dedicated machine. In these setups, the agent starts, executes exactly one workflow, and exits, allowing the environment to be cleanly torn down afterward.
---
### AGENT_LABELS
- Name: `WOODPECKER_AGENT_LABELS`
@@ -215,6 +228,19 @@ Configures if the gRPC server certificate should be verified, only valid when `W
---
## RETRY_TIMEOUT
- Name: `WOODPECKER_RETRY_TIMEOUT`
- Default: `2m`
Set how long the agent keeps retrying to reconnect to the server after the gRPC connection is lost before giving up.
:::warning
If set to 0 we retry forever.
:::
---
### BACKEND
- Name: `WOODPECKER_BACKEND`
@@ -36,23 +36,23 @@ woodpecker-cli [GLOBAL OPTIONS] [command [COMMAND OPTIONS]] [ARGUMENTS...]
**--config, -c**="": path to config file
**--disable-update-check**: disable update check
**--disable-update-check**: disable update check (default: false)
**--log-file**="": Output destination for logs. 'stdout' and 'stderr' can be used as special keywords. (default: stderr)
**--log-level**="": set logging level (default: info)
**--nocolor**: disable colored debug output, only has effect if pretty output is set too
**--nocolor**: disable colored debug output, only has effect if pretty output is set too (default: false)
**--pretty**: enable pretty-printed debug output
**--pretty**: enable pretty-printed debug output (default: true)
**--server, -s**="": server address
**--skip-verify**: skip ssl verification
**--skip-verify**: skip ssl verification (default: false)
**--socks-proxy**="": socks proxy address
**--socks-proxy-off**: socks proxy ignored
**--socks-proxy-off**: socks proxy ignored (default: false)
**--token, -t**="": server auth token
@@ -75,9 +75,7 @@ manage organizations
list organizations
**--format**="": format output (deprecated) (default: {{ .Name }} 
Organization ID: {{ .ID }}
)
**--format**="": format output (deprecated) (default: \x1b[33m{{ .Name }} \x1b[0m\nOrganization ID: {{ .ID }}\n)
### registry
@@ -103,19 +101,13 @@ remove a registry
list registries
**--format**="": format output (deprecated) (default: {{ .Address }} 
Username: {{ .Username }}
Email: {{ .Email }}
)
**--format**="": format output (deprecated) (default: \x1b[33m{{ .Address }} \x1b[0m\nUsername: {{ .Username }}\nEmail: {{ .Email }}\n)
#### show
show registry information
**--format**="": format output (deprecated) (default: {{ .Address }} 
Username: {{ .Username }}
Email: {{ .Email }}
)
**--format**="": format output (deprecated) (default: \x1b[33m{{ .Address }} \x1b[0m\nUsername: {{ .Username }}\nEmail: {{ .Email }}\n)
**--hostname**="": registry hostname (default: docker.io)
@@ -139,9 +131,9 @@ manage global secrets
add a secret
**--event**="": secret limited to these events (default: [])
**--event**="": secret limited to these events
**--image**="": secret limited to these images (default: [])
**--image**="": secret limited to these images
**--name**="": secret name
@@ -157,27 +149,13 @@ remove a secret
list secrets
**--format**="": format output (deprecated) (default: {{ .Name }} 
Events: {{ list .Events }}
{{- if .Images }}
Images: {{ list .Images }}
{{- else }}
Images: <any>
{{- end }}
)
**--format**="": format output (deprecated) (default: \x1b[33m{{ .Name }} \x1b[0m\nEvents: {{ list .Events }}\n{{- if .Images }}\nImages: {{ list .Images }}\n{{- else }}\nImages: <any>\n{{- end }}\n)
#### show
show secret information
**--format**="": format output (deprecated) (default: {{ .Name }} 
Events: {{ list .Events }}
{{- if .Images }}
Images: {{ list .Images }}
{{- else }}
Images: <any>
{{- end }}
)
**--format**="": format output (deprecated) (default: \x1b[33m{{ .Name }} \x1b[0m\nEvents: {{ list .Events }}\n{{- if .Images }}\nImages: {{ list .Images }}\n{{- else }}\nImages: <any>\n{{- end }}\n)
**--name**="": secret name
@@ -185,9 +163,9 @@ Images: <any>
update a secret
**--event**="": secret limited to these events (default: [])
**--event**="": secret limited to these events
**--image**="": secret limited to these images (default: [])
**--image**="": secret limited to these images
**--name**="": secret name
@@ -215,8 +193,33 @@ remove a user
show user information
**--format**="": format output (default: User: {{ .Login }}
Email: {{ .Email }})
**--format**="": format output (default: User: {{ .Login }}\nEmail: {{ .Email }})
## context, ctx
manage contexts
### list, ls
list all contexts
**--output**="": output format (default: table)
**--output-no-headers**: do not print headers in output (default: false)
**--output-no-headers**: don't print headers (default: false)
### use
set the current context
### delete, rm
delete a context
### rename
rename a context
## exec
@@ -228,7 +231,7 @@ execute a local pipeline
**--backend-docker-host**="": path to docker socket or url to the docker server
**--backend-docker-ipv6**: backend docker enable IPV6
**--backend-docker-ipv6**: backend docker enable IPV6 (default: false)
**--backend-docker-limit-cpu-quota**="": impose a cpu quota (default: 0)
@@ -244,7 +247,9 @@ execute a local pipeline
**--backend-docker-network**="": backend docker network
**--backend-docker-tls-verify**: enable or disable TLS verification for connecting to docker server
**--backend-docker-stop-timeout**="": seconds Woodpecker waits for a container to stop gracefully before forcefully killing it (default: 20)
**--backend-docker-tls-verify**: enable or disable TLS verification for connecting to docker server (default: true)
**--backend-docker-volumes**="": backend docker volumes (comma separated)
@@ -254,38 +259,46 @@ execute a local pipeline
**--backend-https-proxy**="": if set, pass the environment variable down as "HTTPS_PROXY" to steps
**--backend-k8s-allow-native-secrets**: whether to allow existing Kubernetes secrets to be referenced from steps
**--backend-k8s-allow-native-secrets**: whether to allow existing Kubernetes secrets to be referenced from steps (default: false)
**--backend-k8s-namespace**="": backend k8s namespace, if used with WOODPECKER_BACKEND_K8S_NAMESPACE_PER_ORGANIZATION, this will be the prefix for the namespace appended with the organization name. (default: woodpecker)
**--backend-k8s-namespace-per-org**: Whether to enable namespace segregation per organization feature. When enabled, Woodpecker will create the Kubernetes resources to separated Kubernetes namespaces per Woodpecker organization.
**--backend-k8s-namespace-per-org**: Whether to enable namespace segregation per organization feature. When enabled, Woodpecker will create the Kubernetes resources to separated Kubernetes namespaces per Woodpecker organization. (default: false)
**--backend-k8s-pod-affinity**="": backend k8s Agent-wide worker pod affinity, in YAML format
**--backend-k8s-pod-affinity-allow-from-step**: whether to allow using affinity from step's backend options (default: false)
**--backend-k8s-pod-annotations**="": backend k8s additional Agent-wide worker pod annotations
**--backend-k8s-pod-annotations-allow-from-step**: whether to allow using annotations from step's backend options
**--backend-k8s-pod-annotations-allow-from-step**: whether to allow using annotations from step's backend options (default: false)
**--backend-k8s-pod-image-pull-secret-names**="": backend k8s pull secret names for private registries (default: [])
**--backend-k8s-pod-image-pull-secret-names**="": backend k8s pull secret names for private registries
**--backend-k8s-pod-labels**="": backend k8s additional Agent-wide worker pod labels
**--backend-k8s-pod-labels-allow-from-step**: whether to allow using labels from step's backend options
**--backend-k8s-pod-labels-allow-from-step**: whether to allow using labels from step's backend options (default: false)
**--backend-k8s-pod-node-selector**="": backend k8s Agent-wide worker pod node selector
**--backend-k8s-pod-tolerations**="": backend k8s Agent-wide worker pod tolerations
**--backend-k8s-pod-tolerations-allow-from-step**: whether to allow using tolerations from step's backend options
**--backend-k8s-pod-tolerations-allow-from-step**: whether to allow using tolerations from step's backend options (default: true)
**--backend-k8s-priority-class**="": which kubernetes priority class to assign to created job pods
**--backend-k8s-secctx-nonroot**: `run as non root` Kubernetes security context option
**--backend-k8s-secctx-nonroot**: `run as non root` Kubernetes security context option (default: false)
**--backend-k8s-stop-timeout**="": seconds Woodpecker waits for pods to stop gracefully before forcefully killing them (default: 20)
**--backend-k8s-storage-class**="": backend k8s storage class
**--backend-k8s-storage-rwx**: backend k8s storage access mode, should ReadWriteMany (RWX) instead of ReadWriteOnce (RWO) be used? (default: true)
**--backend-k8s-storage-rwx**: backend k8s storage access mode, should ReadWriteMany (RWX) instead of ReadWriteOnce (RWO) be used? (default: true) (default: true)
**--backend-k8s-volume-size**="": backend k8s volume size (default 10G) (default: 10G)
**--backend-local-isolated-home**: set HOME, USERPROFILE and other variables to an isolated directory, if false we ignore netrc (default: true)
**--backend-local-temp-dir**="": set a different temp dir to clone workflows into (default: system temporary directory)
**--backend-no-proxy**="": if set, pass the environment variable down as "NO_PROXY" to steps
@@ -300,7 +313,7 @@ execute a local pipeline
**--commit-message**="": Set the metadata environment variable "CI_COMMIT_MESSAGE".
**--commit-pull-labels**="": Set the metadata environment variable "CI_COMMIT_PULL_REQUEST_LABELS". (default: [])
**--commit-pull-labels**="": Set the metadata environment variable "CI_COMMIT_PULL_REQUEST_LABELS".
**--commit-pull-milestone**="": Set the metadata environment variable "CI_COMMIT_PULL_REQUEST_MILESTONE".
@@ -308,17 +321,17 @@ execute a local pipeline
**--commit-refspec**="": Set the metadata environment variable "CI_COMMIT_REFSPEC".
**--commit-release-is-pre**: Set the metadata environment variable "CI_COMMIT_PRERELEASE".
**--commit-release-is-pre**: Set the metadata environment variable "CI_COMMIT_PRERELEASE". (default: false)
**--commit-sha**="": Set the metadata environment variable "CI_COMMIT_SHA".
**--env**="": Set the metadata environment variable "CI_ENV". (default: [])
**--env**="": Set the metadata environment variable "CI_ENV".
**--forge-type**="": Set the metadata environment variable "CI_FORGE_TYPE".
**--forge-url**="": Set the metadata environment variable "CI_FORGE_URL".
**--local**: run from local directory
**--local**: run from local directory (default: true)
**--metadata-file**="": path to pipeline metadata file (normally downloaded from UI). Parameters can be adjusted by applying additional cli flags
@@ -328,7 +341,7 @@ execute a local pipeline
**--netrc-username**="":
**--network**="": external networks (default: [])
**--network**="": external networks
**--pipeline-changed-files**="": Set the metadata environment variable "CI_PIPELINE_FILES", either json formatted list of strings, or comma separated string list.
@@ -348,7 +361,7 @@ execute a local pipeline
**--pipeline-url**="": Set the metadata environment variable "CI_PIPELINE_FORGE_URL".
**--plugins-privileged**="": Allow plugins to run in privileged mode, if environment variable is defined but empty there will be none (default: [])
**--plugins-privileged**="": Allow plugins to run in privileged mode, if environment variable is defined but empty there will be none
**--prev-commit-author-avatar**="": Set the metadata environment variable "CI_PREV_COMMIT_AUTHOR_AVATAR".
@@ -398,17 +411,17 @@ execute a local pipeline
**--repo-remote-id**="": Set the metadata environment variable "CI_REPO_REMOTE_ID".
**--repo-trusted-network**: Set the metadata environment variable "CI_REPO_TRUSTED_NETWORK".
**--repo-trusted-network**: Set the metadata environment variable "CI_REPO_TRUSTED_NETWORK". (default: false)
**--repo-trusted-security**: Set the metadata environment variable "CI_REPO_TRUSTED_SECURITY".
**--repo-trusted-security**: Set the metadata environment variable "CI_REPO_TRUSTED_SECURITY". (default: false)
**--repo-trusted-volumes**: Set the metadata environment variable "CI_REPO_TRUSTED_VOLUMES".
**--repo-trusted-volumes**: Set the metadata environment variable "CI_REPO_TRUSTED_VOLUMES". (default: false)
**--repo-url**="": Set the metadata environment variable "CI_REPO_URL".
**--secrets**="": map of secrets, ex. 'secret="val",secret2="value2"' (default: map[])
**--secrets**="": map of secrets, ex. 'secret="val",secret2="value2"'
**--secrets**="": path to yaml file with secrets map
**--secrets-file**="": path to yaml file with secrets map
**--system-host**="": Set the metadata environment variable "CI_SYSTEM_HOST".
@@ -420,7 +433,7 @@ execute a local pipeline
**--timeout**="": pipeline timeout (default: 1h0m0s)
**--volumes**="": pipeline volumes (default: [])
**--volumes**="": pipeline volumes
**--workflow-name**="": Set the metadata environment variable "CI_WORKFLOW_NAME".
@@ -434,18 +447,17 @@ execute a local pipeline
show information about the current user
**--format**="": format output (deprecated) (default: User: {{ .Login }}
Email: {{ .Email }})
**--format**="": format output (deprecated) (default: User: {{ .Login }}\nEmail: {{ .Email }})
## lint
lint a pipeline configuration file
**--plugins-privileged**="": allow plugins to run in privileged mode, if set empty, there is no (default: [])
**--plugins-privileged**="": allow plugins to run in privileged mode, if set empty, there is no
**--plugins-trusted-clone**="": plugins that are trusted to handle Git credentials in cloning steps (default: [docker.io/woodpeckerci/plugin-git:2.7.0 docker.io/woodpeckerci/plugin-git quay.io/woodpeckerci/plugin-git])
**--plugins-trusted-clone**="": plugins that are trusted to handle Git credentials in cloning steps (default: "docker.io/woodpeckerci/plugin-git:2.9.0", "docker.io/woodpeckerci/plugin-git", "quay.io/woodpeckerci/plugin-git")
**--strict**: treat warnings as errors
**--strict**: treat warnings as errors (default: false)
## org
@@ -479,10 +491,7 @@ remove a registry
list registries
**--format**="": format output (deprecated) (default: {{ .Address }} 
Username: {{ .Username }}
Email: {{ .Email }}
)
**--format**="": format output (deprecated) (default: \x1b[33m{{ .Address }} \x1b[0m\nUsername: {{ .Username }}\nEmail: {{ .Email }}\n)
**--organization, --org**="": organization id or full name (e.g. 123 or octocat)
@@ -490,10 +499,7 @@ Email: {{ .Email }}
show registry information
**--format**="": format output (deprecated) (default: {{ .Address }} 
Username: {{ .Username }}
Email: {{ .Email }}
)
**--format**="": format output (deprecated) (default: \x1b[33m{{ .Address }} \x1b[0m\nUsername: {{ .Username }}\nEmail: {{ .Email }}\n)
**--hostname**="": registry hostname (default: docker.io)
@@ -519,9 +525,9 @@ manage secrets
add a secret
**--event**="": secret limited to these events (default: [])
**--event**="": secret limited to these events
**--image**="": secret limited to these images (default: [])
**--image**="": secret limited to these images
**--name**="": secret name
@@ -541,14 +547,7 @@ remove a secret
list secrets
**--format**="": format output (deprecated) (default: {{ .Name }} 
Events: {{ list .Events }}
{{- if .Images }}
Images: {{ list .Images }}
{{- else }}
Images: <any>
{{- end }}
)
**--format**="": format output (deprecated) (default: \x1b[33m{{ .Name }} \x1b[0m\nEvents: {{ list .Events }}\n{{- if .Images }}\nImages: {{ list .Images }}\n{{- else }}\nImages: <any>\n{{- end }}\n)
**--organization, --org**="": organization id or full name (e.g. 123 or octocat)
@@ -556,14 +555,7 @@ Images: <any>
show secret information
**--format**="": format output (deprecated) (default: {{ .Name }} 
Events: {{ list .Events }}
{{- if .Images }}
Images: {{ list .Images }}
{{- else }}
Images: <any>
{{- end }}
)
**--format**="": format output (deprecated) (default: \x1b[33m{{ .Name }} \x1b[0m\nEvents: {{ list .Events }}\n{{- if .Images }}\nImages: {{ list .Images }}\n{{- else }}\nImages: <any>\n{{- end }}\n)
**--name**="": secret name
@@ -573,9 +565,9 @@ Images: <any>
update a secret
**--event**="": limit secret to these event (default: [])
**--event**="": limit secret to these event
**--image**="": limit secret to these image (default: [])
**--image**="": limit secret to these image
**--name**="": secret name
@@ -599,9 +591,9 @@ create new pipeline
**--output**="": output format (default: table)
**--output-no-headers**: don't print headers
**--output-no-headers**: don't print headers (default: false)
**--var**="": key=value (default: [])
**--var**="": key=value
### decline
@@ -615,17 +607,9 @@ trigger a pipeline with the 'deployment' event
**--event**="": event filter (default: push)
**--format**="": format output (default: Number: {{ .Number }}
Status: {{ .Status }}
Commit: {{ .Commit }}
Branch: {{ .Branch }}
Ref: {{ .Ref }}
Message: {{ .Message }}
Author: {{ .Author }}
Target: {{ .Deploy }}
)
**--format**="": format output (default: Number: {{ .Number }}\nStatus: {{ .Status }}\nCommit: {{ .Commit }}\nBranch: {{ .Branch }}\nRef: {{ .Ref }}\nMessage: {{ .Message }}\nAuthor: {{ .Author }}\nTarget: {{ .Deploy }}\n)
**--param, -p**="": custom parameters to inject into the step environment. Format: KEY=value (default: [])
**--param, -p**="": custom parameters to inject into the step environment. Format: KEY=value
**--status**="": status filter (default: success)
@@ -637,15 +621,15 @@ show latest pipeline information
**--output**="": output format (default: table)
**--output-no-headers**: don't print headers
**--output-no-headers**: don't print headers (default: false)
### ls
show pipeline history
**--after**="": only return pipelines after this date (RFC3339) (default: 0001-01-01 00:00:00 +0000 UTC)
**--after**="": only return pipelines after this date (RFC3339)
**--before**="": only return pipelines before this date (RFC3339) (default: 0001-01-01 00:00:00 +0000 UTC)
**--before**="": only return pipelines before this date (RFC3339)
**--branch**="": branch filter
@@ -655,7 +639,7 @@ show pipeline history
**--output**="": output format (default: table)
**--output-no-headers**: don't print headers
**--output-no-headers**: don't print headers (default: false)
**--status**="": status filter
@@ -675,13 +659,7 @@ show pipeline logs
show pipeline steps
**--format**="": format output (default: {{ .workflow.Name }} > {{ .step.Name }} (#{{ .step.PID }}):
Step: {{ .step.Name }}
Started: {{ .step.Started }}
Stopped: {{ .step.Stopped }}
Type: {{ .step.Type }}
State: {{ .step.State }}
)
**--format**="": format output (default: \x1b[33m{{ .workflow.Name }} > {{ .step.Name }} (#{{ .step.PID }}):\x1b[0m\nStep: {{ .step.Name }}\nStarted: {{ .step.Started }}\nStopped: {{ .step.Stopped }}\nType: {{ .step.Type }}\nState: {{ .step.State }}\n)
### purge
@@ -689,7 +667,7 @@ purge pipelines
**--branch**="": remove pipelines of this branch only
**--dry-run**: disable non-read api calls
**--dry-run**: disable non-read api calls (default: false)
**--keep-min**="": minimum number of pipelines to keep (default: 10)
@@ -699,15 +677,7 @@ purge pipelines
show pipeline queue
**--format**="": format output (default: {{ .FullName }} #{{ .Number }} 
Status: {{ .Status }}
Event: {{ .Event }}
Commit: {{ .Commit }}
Branch: {{ .Branch }}
Ref: {{ .Ref }}
Author: {{ .Author }} {{ if .Email }}<{{.Email}}>{{ end }}
Message: {{ .Message }}
)
**--format**="": format output (default: \x1b[33m{{ .FullName }} #{{ .Number }} \x1b[0m\nStatus: {{ .Status }}\nEvent: {{ .Event }}\nCommit: {{ .Commit }}\nBranch: {{ .Branch }}\nRef: {{ .Ref }}\nAuthor: {{ .Author }} {{ if .Email }}<{{.Email}}>{{ end }}\nMessage: {{ .Message }}\n)
### show
@@ -715,13 +685,13 @@ show pipeline information
**--output**="": output format (default: table)
**--output-no-headers**: don't print headers
**--output-no-headers**: don't print headers (default: false)
### start
start a pipeline
**--param, -p**="": custom parameters to inject into the step environment. Format: KEY=value (default: [])
**--param, -p**="": custom parameters to inject into the step environment. Format: KEY=value
### stop
@@ -749,12 +719,9 @@ add a cron job
**--branch**="": cron branch
**--format**="": format output (deprecated) (default: {{ .Name }} 
ID: {{ .ID }}
Branch: {{ .Branch }}
Schedule: {{ .Schedule }}
NextExec: {{ .NextExec }}
)
**--enabled**: whether cron is enabled (default: true)
**--format**="": format output (deprecated) (default: \x1b[33m{{ .Name }} \x1b[0m\nID: {{ .ID }}\nBranch: {{ .Branch }}\nSchedule: {{ .Schedule }}\nNextExec: {{ .NextExec }}\n)
**--name**="": cron name
@@ -774,12 +741,7 @@ remove a cron job
list cron jobs
**--format**="": format output (deprecated) (default: {{ .Name }} 
ID: {{ .ID }}
Branch: {{ .Branch }}
Schedule: {{ .Schedule }}
NextExec: {{ .NextExec }}
)
**--format**="": format output (deprecated) (default: \x1b[33m{{ .Name }} \x1b[0m\nID: {{ .ID }}\nBranch: {{ .Branch }}\nSchedule: {{ .Schedule }}\nNextExec: {{ .NextExec }}\n)
**--repository, --repo**="": repository id or full name (e.g. 134 or octocat/hello-world)
@@ -787,12 +749,7 @@ NextExec: {{ .NextExec }}
show cron job information
**--format**="": format output (deprecated) (default: {{ .Name }} 
ID: {{ .ID }}
Branch: {{ .Branch }}
Schedule: {{ .Schedule }}
NextExec: {{ .NextExec }}
)
**--format**="": format output (deprecated) (default: \x1b[33m{{ .Name }} \x1b[0m\nID: {{ .ID }}\nBranch: {{ .Branch }}\nSchedule: {{ .Schedule }}\nNextExec: {{ .NextExec }}\n)
**--id**="": cron id
@@ -804,12 +761,9 @@ update a cron job
**--branch**="": cron branch
**--format**="": format output (deprecated) (default: {{ .Name }} 
ID: {{ .ID }}
Branch: {{ .Branch }}
Schedule: {{ .Schedule }}
NextExec: {{ .NextExec }}
)
**--enabled**: whether cron is enabled (default: true)
**--format**="": format output (deprecated) (default: \x1b[33m{{ .Name }} \x1b[0m\nID: {{ .ID }}\nBranch: {{ .Branch }}\nSchedule: {{ .Schedule }}\nNextExec: {{ .NextExec }}\n)
**--id**="": cron id
@@ -823,7 +777,7 @@ NextExec: {{ .NextExec }}
list all repos
**--all**: query all repos, including inactive ones
**--all**: query all repos, including inactive ones (default: false)
**--format**="": format output (deprecated)
@@ -831,7 +785,7 @@ list all repos
**--output**="": output format (default: table)
**--output-no-headers**: don't print headers
**--output-no-headers**: don't print headers (default: false)
### registry
@@ -861,10 +815,7 @@ remove a registry
list registries
**--format**="": format output (deprecated) (default: {{ .Address }} 
Username: {{ .Username }}
Email: {{ .Email }}
)
**--format**="": format output (deprecated) (default: \x1b[33m{{ .Address }} \x1b[0m\nUsername: {{ .Username }}\nEmail: {{ .Email }}\n)
**--repository, --repo**="": repository id or full name (e.g. 134 or octocat/hello-world)
@@ -872,10 +823,7 @@ Email: {{ .Email }}
show registry information
**--format**="": format output (deprecated) (default: {{ .Address }} 
Username: {{ .Username }}
Email: {{ .Email }}
)
**--format**="": format output (deprecated) (default: \x1b[33m{{ .Address }} \x1b[0m\nUsername: {{ .Username }}\nEmail: {{ .Email }}\n)
**--hostname**="": registry hostname (default: docker.io)
@@ -909,9 +857,9 @@ manage secrets
add a secret
**--event**="": limit secret to these events (default: [])
**--event**="": limit secret to these events
**--image**="": limit secret to these images (default: [])
**--image**="": limit secret to these images
**--name**="": secret name
@@ -931,14 +879,7 @@ remove a secret
list secrets
**--format**="": format output (deprecated) (default: {{ .Name }} 
Events: {{ list .Events }}
{{- if .Images }}
Images: {{ list .Images }}
{{- else }}
Images: <any>
{{- end }}
)
**--format**="": format output (deprecated) (default: \x1b[33m{{ .Name }} \x1b[0m\nEvents: {{ list .Events }}\n{{- if .Images }}\nImages: {{ list .Images }}\n{{- else }}\nImages: <any>\n{{- end }}\n)
**--repository, --repo**="": repository id or full name (e.g. 134 or octocat/hello-world)
@@ -946,14 +887,7 @@ Images: <any>
show secret information
**--format**="": format output (deprecated) (default: {{ .Name }} 
Events: {{ list .Events }}
{{- if .Images }}
Images: {{ list .Images }}
{{- else }}
Images: <any>
{{- end }}
)
**--format**="": format output (deprecated) (default: \x1b[33m{{ .Name }} \x1b[0m\nEvents: {{ list .Events }}\n{{- if .Images }}\nImages: {{ list .Images }}\n{{- else }}\nImages: <any>\n{{- end }}\n)
**--name**="": secret name
@@ -963,9 +897,9 @@ Images: <any>
update a secret
**--event**="": limit secret to these events (default: [])
**--event**="": limit secret to these events
**--image**="": limit secret to these images (default: [])
**--image**="": limit secret to these images
**--name**="": secret name
@@ -979,13 +913,13 @@ show repository information
**--output**="": output format (default: table)
**--output-no-headers**: don't print headers
**--output-no-headers**: don't print headers (default: false)
### sync
synchronize the repository list
**--format**="": format output (default: {{ .FullName }} (id: {{ .ID }}, forgeRemoteID: {{ .ForgeRemoteID }}, isActive: {{ .IsActive }}))
**--format**="": format output (default: \x1b[33m{{ .FullName }}\x1b[0m (id: {{ .ID }}, forgeRemoteID: {{ .ForgeRemoteID }}, isActive: {{ .IsActive }}))
### update
@@ -999,9 +933,13 @@ update a repository
**--timeout**="": repository timeout (default: 0s)
**--trusted**: repository is trusted
**--trusted-network**: repository is network trusted (default: false)
**--unsafe**: allow unsafe operations
**--trusted-security**: repository is security trusted (default: false)
**--trusted-volumes**: repository is volumes trusted (default: false)
**--unsafe**: allow unsafe operations (default: false)
**--visibility**="": repository visibility
@@ -1009,6 +947,8 @@ update a repository
setup the woodpecker-cli for the first time
**--context, --ctx**="": name for the context (defaults to 'default')
**--server**="": URL of the woodpecker server
**--token**="": token to authenticate with the woodpecker server
@@ -1017,4 +957,4 @@ setup the woodpecker-cli for the first time
update the woodpecker-cli to the latest version
**--force**: force update even if the latest version is already installed
**--force**: force update even if the latest version is already installed (default: false)
@@ -20,7 +20,7 @@ Start Woodpecker in Gitpod by clicking on the following badge. You can log in wi
### Install Go
Install Golang (>=1.20) as described by [this guide](https://go.dev/doc/install).
Install Golang as described by [this guide](https://go.dev/doc/install).
### Install make
@@ -34,7 +34,7 @@ Install make on:
### Install Node.js & `pnpm`
Install [Node.js (>=20)](https://nodejs.org/en/download/package-manager) if you want to build Woodpecker's UI or documentation.
Install [Node.js](https://nodejs.org/en/download/package-manager) if you want to build Woodpecker's UI or documentation.
For dependency installation (`node_modules`) of UI and documentation of Woodpecker the package manager pnpm is used.
[This guide](https://pnpm.io/installation) describes the installation of `pnpm`.
@@ -8,7 +8,7 @@
## Addons and extensions
If you are wondering whether your contribution will be accepted to be merged in the Woodpecker core, or whether it's better to write an
[addon forge](../30-administration/10-configuration/12-forges/100-addon.md), [extension](../30-administration/10-configuration/10-server.md#external-configuration-api) or an
[addon](../30-administration/10-configuration/100-addons.md), [extension](../20-usage/72-extensions/40-configuration-extension.md) or an
[external custom backend](../30-administration/10-configuration/11-backends/50-custom.md), please check these points:
- Is your change very specific to your setup and unlikely to be used by anyone else?
@@ -0,0 +1,98 @@
# Architecture
## Module Interactions
![Woodpecker architecture](./woodpecker-architecture.svg)
<!--
To update the graph, first look at a simple svg of all module imports:
`go run github.com/loov/goda@latest graph 'go.woodpecker-ci.org/woodpecker/v3/...' | dot -Tsvg -o graph.svg`
generate a new svg of the graph using:
`dot -Tsvg woodpecker-architecture.dot -o woodpecker-architecture.svg`
-->
## System architecture
### main package hierarchy
| package | meaning | imports |
| ------------------ | -------------------------------------------------------------- | ------------------------------------- |
| `cmd/**` | parse command-line args & environment to stat server/cli/agent | all other |
| `agent/**` | code only agent (remote worker) will need | `pipeline`, `rpc`, `shared` |
| `cli/**` | code only cli tool does need | `pipeline`, `shared`, `woodpecker-go` |
| `server/**` | code only server will need | `pipeline`, `rpc`, `shared` |
| `pipeline/**` | core ci/cd engine from parsing to execution | `shared` |
| `rpc/**` | RPC interface for agent-server communication | `pipeline` |
| `shared/**` | code shared for all three main tools (go help utils) | only std and external libs |
| `woodpecker-go/**` | go client for server rest api | std |
### Server
| package | meaning | imports |
| -------------------- | ------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `server/api/**` | handle web requests from `server/router` | `pipeline`, `rpc`, `../badges`, `../ccmenu`, `../logging`, `../model`, `../pubsub`, `../queue`, `../forge`, `../shared`, `../store`, `shared`, (TODO: mv `server/router/middleware/session`) |
| `server/badges/**` | generate svg badges for pipelines | `../model` |
| `server/ccmenu/**` | generate xml ccmenu for pipelines | `../model` |
| `server/rpc/**` | gRPC server agents can connect to | `rpc`, `../logging`, `../model`, `../pubsub`, `../queue`, `../forge`, `../pipeline`, `../store` |
| `server/logging/**` | logging lib for gPRC server to stream logs while running | std |
| `server/model/**` | structs for store (db) and api (json) | std |
| `server/pipeline/**` | orchestrate pipelines (TODO: parts of it should move into /pipeline) | `pipeline`, `../model`, `../pubsub`, `../queue`, `../forge`, `../store`, `../plugins` |
| `server/pubsub/**` | pubsub lib for server to push changes to the WebUI | std |
| `server/queue/**` | queue lib for server where agents pull new pipelines from via gRPC | `server/model` |
| `server/forge/**` | forge lib for server to connect and handle forge specific stuff | `shared`, `server/model` |
| `server/router/**` | handle requests to REST API (and all middleware) and serve UI and WebUI config | `shared`, `../api`, `../model`, `../forge`, `../store`, `../web` |
| `server/store/**` | handle database | `server/model` |
| `server/web/**` | server SPA | |
- `../` = `server/`
### Agent
| package | meaning | imports |
| -------------- | ---------------------------------------------------- | ------------------------------------------------------ |
| `agent/**` | agent implementation that runs workflows | `pipeline`, `rpc`, `shared` |
| `agent/rpc/**` | gRPC client for agent-server communication | `rpc`, `pipeline/backend/types`, std and external libs |
| `cmd/agent/**` | CLI interface for starting and configuring the agent | `agent`, std and external libs |
The agent is a remote worker that connects to the server via gRPC to receive pipeline execution instructions and report back execution state and logs.
The agent polls the server's queue for new work, executes pipeline steps using the pipeline engine, and streams results back to the server.
TODO: Review cmd/agent/core to determine if any logic should be moved into the agent package for better separation of concerns.
### CLI
| package | meaning | imports |
| ------------------------ | ----------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| `cli/admin/**` | admin commands for server management (users, secrets, registries, etc.) | `../common`, `../internal`, `woodpecker-go` |
| `cli/common/**` | shared utilities and helpers used across all CLI subcommands | `../internal/config`, `../update`, `shared` |
| `cli/context/**` | manage multiple server contexts (connections to different servers) | `../common`, `../internal/config`, `../output` |
| `cli/exec/**` | execute pipelines locally without server orchestration | `pipeline`, `../common`, `../lint`, `shared` |
| `cli/info/**` | display information about the current user | `../common`, `../internal` |
| `cli/internal/**` | internal utilities for HTTP client, auth, and server communication | `../internal/config`, `woodpecker-go`, `shared` |
| `cli/internal/config/**` | configuration file management (load, store, credentials) | std and external libs |
| `cli/lint/**` | validate pipeline configuration files | `pipeline/frontend/yaml`, `pipeline/frontend/yaml/linter`, `../common`, `shared` |
| `cli/org/**` | manage organization-level resources (secrets, registries) | `../common`, `../internal`, `woodpecker-go` |
| `cli/output/**` | formatting utilities for CLI output (tables, etc.) | std and external libs |
| `cli/pipeline/**` | manage pipeline operations (start, stop, approve, logs, etc.) | `../common`, `../internal`, `../output`, `woodpecker-go`, `shared` |
| `cli/repo/**` | manage repository-level resources (repos, crons, secrets, registries) | `../common`, `../internal`, `../output`, `woodpecker-go` |
| `cli/setup/**` | interactive first-time setup wizard for CLI configuration | `../internal/config` |
| `cli/update/**` | self-updater for the CLI binary | std and external libs |
| `cmd/cli/**` | CLI entry point and command structure | `cli/**` |
The CLI provides a command-line interface for interacting with Woodpecker servers.
Each subcommand is organized into its own package under `cli/<subcommand>/`.
The `cli/exec` subcommand allows local pipeline execution for testing and development by combining pipeline parsing and execution without requiring a running server or agent.
- `../` = `cli/`
### Engine
The engine is the shared kernel that validates, parses frontend facing config files, enrich it by the provided forge metadata and produce config for the backends to execute on based on that. It also contains the default backend implementations.
#### Runtime
The runtime is the package controlling how a workflow is executed, and can be found at `pipeline/runtime`.
<img src="/svg/woodpecker-workflow-run-flowchart.svg" alt="Pipeline/runtime flow diagram" style="max-width: 600px; width: 100%;" />
@@ -4,4 +4,4 @@
Database tables are named plural, columns don't have any prefix.
Example: Table name `agent`, columns `id`, `name`.
Example: Model name `Agent` with table name `agents` and columns `id`, `name`.
@@ -5,7 +5,7 @@
### Unit Tests
[We use default golang unit tests](https://go.dev/doc/tutorial/add-a-test)
with [`"github.com/stretchr/testify/assert"`](https://pkg.go.dev/github.com/stretchr/testify@v1.9.0/assert) to simplify testing.
with [`"github.com/stretchr/testify/assert"`](https://pkg.go.dev/github.com/stretchr/testify/assert) to simplify testing.
### Integration Tests
@@ -0,0 +1,18 @@
# Packaging
If you repackage it, we encourage to build from source, which requires internet connection.
For offline builds, we also offer a tarball with all vendored dependencies and a pre-built web UI
on the [release page](https://github.com/woodpecker-ci/woodpecker/releases).
## Distribute web UI in own directory
If you do not want to embed the web UI in the binary, you can compile a custom root path for the web UI into the binary.
Add `external_web` to the tags and use the build flag `-X go.woodpecker-ci.org/woodpecker/v3/web.webUIRoot=/some/path` to set a custom path.
Example: <!-- cspell:ignore webui -->
```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
```
@@ -1,34 +1,16 @@
# Custom
# Addons
If the forge you are using does not meet the [Woodpecker requirements](../../../92-development/02-core-ideas.md#forges) or your setup is too specific to be included in the Woodpecker core, you can write an addon forge.
The Woodpecker server supports addons for forges and the log store.
:::warning
Addon forges are still experimental. Their implementation can change and break at any time.
Addons are still experimental. Their implementation can change and break at any time.
:::
:::danger
You must trust the author of the addon forge you are using. They may have access to authentication codes and other potentially sensitive information.
:::
## Usage
To use an addon forge, download the correct addon version. Then, you can add the following to your configuration:
```ini
WOODPECKER_ADDON_FORGE=/path/to/your/addon/forge/file
```
In case you run Woodpecker as container, you probably want to mount the addon binary to `/opt/addons/`.
### Bug reports
## Bug reports
If you experience bugs, please check which component has the issue. If it's the addon, **do not raise an issue in the main repository**, but rather use the separate addon repositories. To check which component is responsible for the bug, look at the logs. Logs from addons are marked with a special field `addon` containing their addon file name.
## List of addon forges
- [Radicle](https://radicle.xyz/): Open source, peer-to-peer code collaboration stack built on Git. Radicle addon for Woodpecker CI can be found at [this repo](https://explorer.radicle.gr/nodes/seed.radicle.gr/rad:z39Cf1XzrvCLRZZJRUZnx9D1fj5ws).
## Creating addon forges
## Creating addons
Addons use RPC to communicate to the server and are implemented using the [`go-plugin` library](https://github.com/hashicorp/go-plugin).
@@ -38,7 +20,7 @@ This example will use the Go language.
Directly import Woodpecker's Go packages (`go.woodpecker-ci.org/woodpecker/v3`) and use the interfaces and types defined there.
In the `main` function, just call `"go.woodpecker-ci.org/woodpecker/v3/server/forge/addon".Serve` with a `"go.woodpecker-ci.org/woodpecker/v3/server/forge".Forge` as argument.
In the `main` function, just call the `Serve` method in the corresponding [addon package](#addon-types) with the service as argument.
This will take care of connecting the addon forge to the server.
:::note
@@ -47,6 +29,8 @@ It is not possible to access global variables from Woodpecker, for example the s
### Example structure
This is an example for a forge addon.
```go
package main
@@ -68,3 +52,10 @@ 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.
```
### Addon types
| Type | Addon package | Service interface |
| --------- | ------------------------------------------------------------- | ----------------------------------------------------------------- |
| Forge | `go.woodpecker-ci.org/woodpecker/v3/server/forge/addon` | `"go.woodpecker-ci.org/woodpecker/v3/server/forge".Forge` |
| Log store | `go.woodpecker-ci.org/woodpecker/v3/server/service/log/addon` | `"go.woodpecker-ci.org/woodpecker/v3/server/service/log".Service` |
@@ -0,0 +1,43 @@
# Deprecation Policy
## Pipeline Configuration Changes
Pipeline configuration (YAML syntax) changes follow a strict deprecation process to ensure users have sufficient time to migrate.
### Process Timeline
1. **Minor Version N.x - Add Deprecation Warning**
- Linter shows a warning (not an error)
- Old syntax remains functional
- Documentation is updated to reflect the new syntax
- Warning message includes guidance on required changes
2. **Major Version (N+1).0 - Warning Becomes Error**
- Linter issues an error (pipeline fails)
- Old syntax is no longer supported
- Breaking change is documented in the migration guide
- Users **must** update their configurations
3. **Minor Version (N+1).x - Code Cleanup**
- Deprecated code paths are removed
- Implementation is simplified/refactored
- Parser no longer recognizes the old syntax
### Example
Old syntax: `secrets: [token]`
New syntax: `environment: { TOKEN: { from_secret: token } }`
- **v2.5.0:** Deprecation warning added in linter; both syntaxes work
- **v2.6-2.9:** Warning persists; both syntaxes remain functional
- **v3.0.0:** Linter error; old syntax fails (breaking change)
- **v3.1.0:** Deprecated code paths removed; parser simplified
### Implementation Checklist
When deprecating pipeline configuration syntax, ensure the following:
- [ ] Add linter warning in `/pipeline/frontend/yaml/linter/`
- [ ] Update JSON schema in `/pipeline/frontend/yaml/linter/schema`
- [ ] Add test cases for deprecated syntax
- [ ] Update documentation to reflect the new syntax

Before

Width:  |  Height:  |  Size: 7.5 KiB

After

Width:  |  Height:  |  Size: 7.5 KiB

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 17 KiB

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 11 KiB

@@ -0,0 +1,157 @@
digraph WoodpeckerArchitecture {
graph [
rankdir=TB,
splines=ortho,
nodesep=0.5,
ranksep=0.8,
fontname="Helvetica"
]
node [
shape=box,
style="rounded,filled",
fillcolor="#2b2b2b",
fontcolor="white",
fontname="Helvetica"
]
edge [
color="#bdbdbd",
arrowsize=0.7
]
/* ===================== UI ===================== */
subgraph cluster_ui {
label="UI"
fillcolor="#c7efe9"
fontcolor="black"
style="rounded,filled"
ui_web [label="web/"]
}
/* ===================== SDK ===================== */
subgraph cluster_sdk {
label="SDK (woodpecker-go)"
fillcolor="#e8f5e9"
fontcolor="black"
style="rounded,filled"
sdk [label="woodpecker-go"]
}
/* ===================== CLI ===================== */
subgraph cluster_cli {
label="woodpecker-cli"
fillcolor="#bfe9e0"
fontcolor="black"
style="rounded,filled"
cli_cmd [label="cmd/cli/"]
cli_core [label="cli/"]
}
/* ===================== Agent ===================== */
subgraph cluster_agent {
label="woodpecker-agent"
fillcolor="#ffe0c7"
fontcolor="black"
style="rounded,filled"
agent_cmd [label="cmd/agent/"]
agent_core [label="agent/"]
}
/* ===================== Pipelines ===================== */
subgraph cluster_pipelines {
label="Pipelines"
fillcolor="#ffe8d6"
fontcolor="black"
style="rounded,filled"
pipe_core [label="pipeline/"]
pipe_frontend [label="pipeline/frontend/\n(yaml)"]
pipe_backend [label="pipeline/backend/\n(exec engines)"]
}
/* ===================== Server ===================== */
subgraph cluster_server {
label="woodpecker-server"
fillcolor="#dbe9ff"
fontcolor="black"
style="rounded,filled"
srv_cmd [label="cmd/server/"]
srv_router [label="server/router/"]
srv_api [label="server/api/"]
srv_grpc [label="server/rpc/"]
srv_queue [label="server/queue/"]
srv_pubsub [label="server/pubsub/"]
srv_store [label="server/store/"]
srv_model [label="server/model/"]
srv_forge [label="server/forge/"]
}
/* ===================== Shared Libs ===================== */
subgraph cluster_shared {
label="Shared Libs"
fillcolor="#eeeeee"
fontcolor="black"
style="rounded,filled"
shared_util [label="shared/util/"]
shared_token [label="shared/token/"]
shared_http [label="shared/httputil/"]
shared_log [label="shared/logger/"]
}
/* ===================== External ===================== */
subgraph cluster_external {
label="External Systems"
style="rounded,dashed"
fontcolor="white"
ext_scm [label="SCM Providers", shape=cloud]
ext_db [label="Database", shape=cylinder]
}
/* ===================== Runtime Interactions ===================== */
/* UI */
ui_web -> srv_router [xlabel="HTTP"]
ui_web -> srv_api [xlabel="REST API"]
/* CLI */
cli_cmd -> cli_core
cli_core -> sdk
sdk -> srv_api [xlabel="REST API"]
/* Agent */
agent_cmd -> agent_core
agent_core -> srv_grpc [xlabel="gRPC connect"]
agent_core -> srv_queue [xlabel="poll work"]
agent_core -> pipe_backend [xlabel="execute steps"]
/* Pipelines */
pipe_frontend -> pipe_core
pipe_core -> pipe_backend
/* Server internal flow */
srv_cmd -> srv_router
srv_router -> srv_api
srv_api -> srv_store
srv_api -> srv_pubsub
srv_api -> srv_queue
srv_grpc -> srv_queue
srv_store -> srv_model
/* External integrations */
srv_forge -> ext_scm [xlabel="SCM API"]
srv_store -> ext_db [xlabel="SQL"]
/* Shared libs usage (consumer -> library) */
srv_router -> shared_token
srv_api -> shared_http
srv_grpc -> shared_log
pipe_core -> shared_util
}
@@ -0,0 +1,352 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!-- Generated by graphviz version 12.2.1 (0)
-->
<!-- Title: WoodpeckerArchitecture Pages: 1 -->
<svg width="1112pt" height="577pt"
viewBox="0.00 0.00 1112.00 576.75" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 572.75)">
<title>WoodpeckerArchitecture</title>
<polygon fill="white" stroke="none" points="-4,4 -4,-572.75 1108,-572.75 1108,4 -4,4"/>
<g id="clust1" class="cluster">
<title>cluster_ui</title>
<path fill="#c7efe9" stroke="black" d="M411,-389.25C411,-389.25 457,-389.25 457,-389.25 463,-389.25 469,-395.25 469,-401.25 469,-401.25 469,-453 469,-453 469,-459 463,-465 457,-465 457,-465 411,-465 411,-465 405,-465 399,-459 399,-453 399,-453 399,-401.25 399,-401.25 399,-395.25 405,-389.25 411,-389.25"/>
<text text-anchor="middle" x="434" y="-447.7" font-family="Helvetica,sans-Serif" font-size="14.00">UI</text>
</g>
<g id="clust2" class="cluster">
<title>cluster_sdk</title>
<path fill="#e8f5e9" stroke="black" d="M411,-293.5C411,-293.5 535,-293.5 535,-293.5 541,-293.5 547,-299.5 547,-305.5 547,-305.5 547,-357.25 547,-357.25 547,-363.25 541,-369.25 535,-369.25 535,-369.25 411,-369.25 411,-369.25 405,-369.25 399,-363.25 399,-357.25 399,-357.25 399,-305.5 399,-305.5 399,-299.5 405,-293.5 411,-293.5"/>
<text text-anchor="middle" x="473" y="-351.95" font-family="Helvetica,sans-Serif" font-size="14.00">SDK (woodpecker&#45;go)</text>
</g>
<g id="clust3" class="cluster">
<title>cluster_cli</title>
<path fill="#bfe9e0" stroke="black" d="M493,-389.25C493,-389.25 575,-389.25 575,-389.25 581,-389.25 587,-395.25 587,-401.25 587,-401.25 587,-548.75 587,-548.75 587,-554.75 581,-560.75 575,-560.75 575,-560.75 493,-560.75 493,-560.75 487,-560.75 481,-554.75 481,-548.75 481,-548.75 481,-401.25 481,-401.25 481,-395.25 487,-389.25 493,-389.25"/>
<text text-anchor="middle" x="534" y="-543.45" font-family="Helvetica,sans-Serif" font-size="14.00">woodpecker&#45;cli</text>
</g>
<g id="clust4" class="cluster">
<title>cluster_agent</title>
<path fill="#ffe0c7" stroke="black" d="M636,-293.5C636,-293.5 739,-293.5 739,-293.5 745,-293.5 751,-299.5 751,-305.5 751,-305.5 751,-453 751,-453 751,-459 745,-465 739,-465 739,-465 636,-465 636,-465 630,-465 624,-459 624,-453 624,-453 624,-305.5 624,-305.5 624,-299.5 630,-293.5 636,-293.5"/>
<text text-anchor="middle" x="687.5" y="-447.7" font-family="Helvetica,sans-Serif" font-size="14.00">woodpecker&#45;agent</text>
</g>
<g id="clust5" class="cluster">
<title>cluster_pipelines</title>
<path fill="#ffe8d6" stroke="black" d="M816,-196C816,-196 930,-196 930,-196 936,-196 942,-202 942,-208 942,-208 942,-454.75 942,-454.75 942,-460.75 936,-466.75 930,-466.75 930,-466.75 816,-466.75 816,-466.75 810,-466.75 804,-460.75 804,-454.75 804,-454.75 804,-208 804,-208 804,-202 810,-196 816,-196"/>
<text text-anchor="middle" x="873" y="-449.45" font-family="Helvetica,sans-Serif" font-size="14.00">Pipelines</text>
</g>
<g id="clust6" class="cluster">
<title>cluster_server</title>
<path fill="#dbe9ff" stroke="black" d="M20,-8C20,-8 379,-8 379,-8 385,-8 391,-14 391,-20 391,-20 391,-453 391,-453 391,-459 385,-465 379,-465 379,-465 20,-465 20,-465 14,-465 8,-459 8,-453 8,-453 8,-20 8,-20 8,-14 14,-8 20,-8"/>
<text text-anchor="middle" x="199.5" y="-447.7" font-family="Helvetica,sans-Serif" font-size="14.00">woodpecker&#45;server</text>
</g>
<g id="clust7" class="cluster">
<title>cluster_shared</title>
<path fill="#eeeeee" stroke="black" d="M598,-102C598,-102 1084,-102 1084,-102 1090,-102 1096,-108 1096,-114 1096,-114 1096,-165.75 1096,-165.75 1096,-171.75 1090,-177.75 1084,-177.75 1084,-177.75 598,-177.75 598,-177.75 592,-177.75 586,-171.75 586,-165.75 586,-165.75 586,-114 586,-114 586,-108 592,-102 598,-102"/>
<text text-anchor="middle" x="841" y="-160.45" font-family="Helvetica,sans-Serif" font-size="14.00">Shared Libs</text>
</g>
<g id="clust8" class="cluster">
<title>cluster_external</title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M411,-8C411,-8 621,-8 621,-8 627,-8 633,-14 633,-20 633,-20 633,-71.75 633,-71.75 633,-77.75 627,-83.75 621,-83.75 621,-83.75 411,-83.75 411,-83.75 405,-83.75 399,-77.75 399,-71.75 399,-71.75 399,-20 399,-20 399,-14 405,-8 411,-8"/>
<text text-anchor="middle" x="516" y="-66.45" font-family="Helvetica,sans-Serif" font-size="14.00" fill="white">External Systems</text>
</g>
<!-- ui_web -->
<g id="node1" class="node">
<title>ui_web</title>
<path fill="#2b2b2b" stroke="black" d="M449,-433.25C449,-433.25 419,-433.25 419,-433.25 413,-433.25 407,-427.25 407,-421.25 407,-421.25 407,-409.25 407,-409.25 407,-403.25 413,-397.25 419,-397.25 419,-397.25 449,-397.25 449,-397.25 455,-397.25 461,-403.25 461,-409.25 461,-409.25 461,-421.25 461,-421.25 461,-427.25 455,-433.25 449,-433.25"/>
<text text-anchor="middle" x="434" y="-409.82" font-family="Helvetica,sans-Serif" font-size="14.00" fill="white">web/</text>
</g>
<!-- srv_router -->
<g id="node11" class="node">
<title>srv_router</title>
<path fill="#2b2b2b" stroke="black" d="M269.12,-337.5C269.12,-337.5 196.88,-337.5 196.88,-337.5 190.88,-337.5 184.88,-331.5 184.88,-325.5 184.88,-325.5 184.88,-313.5 184.88,-313.5 184.88,-307.5 190.88,-301.5 196.88,-301.5 196.88,-301.5 269.12,-301.5 269.12,-301.5 275.12,-301.5 281.12,-307.5 281.12,-313.5 281.12,-313.5 281.12,-325.5 281.12,-325.5 281.12,-331.5 275.12,-337.5 269.12,-337.5"/>
<text text-anchor="middle" x="233" y="-314.07" font-family="Helvetica,sans-Serif" font-size="14.00" fill="white">server/router/</text>
</g>
<!-- ui_web&#45;&gt;srv_router -->
<g id="edge1" class="edge">
<title>ui_web&#45;&gt;srv_router</title>
<path fill="none" stroke="#bdbdbd" d="M406.58,-415C400.15,-415 395.12,-415 395.12,-415 395.12,-415 395.12,-326 395.12,-326 395.12,-326 289.72,-326 289.72,-326"/>
<polygon fill="#bdbdbd" stroke="#bdbdbd" points="289.72,-323.55 282.72,-326 289.72,-328.45 289.72,-323.55"/>
<text text-anchor="middle" x="375.77" y="-329.2" font-family="Times,serif" font-size="14.00">HTTP</text>
</g>
<!-- srv_api -->
<g id="node12" class="node">
<title>srv_api</title>
<path fill="#2b2b2b" stroke="black" d="M255.5,-241.75C255.5,-241.75 200.5,-241.75 200.5,-241.75 194.5,-241.75 188.5,-235.75 188.5,-229.75 188.5,-229.75 188.5,-217.75 188.5,-217.75 188.5,-211.75 194.5,-205.75 200.5,-205.75 200.5,-205.75 255.5,-205.75 255.5,-205.75 261.5,-205.75 267.5,-211.75 267.5,-217.75 267.5,-217.75 267.5,-229.75 267.5,-229.75 267.5,-235.75 261.5,-241.75 255.5,-241.75"/>
<text text-anchor="middle" x="228" y="-218.32" font-family="Helvetica,sans-Serif" font-size="14.00" fill="white">server/api/</text>
</g>
<!-- ui_web&#45;&gt;srv_api -->
<g id="edge2" class="edge">
<title>ui_web&#45;&gt;srv_api</title>
<path fill="none" stroke="#bdbdbd" d="M434.94,-396.82C434.94,-379.75 434.94,-357 434.94,-357 434.94,-357 290.88,-357 290.88,-357 290.88,-357 290.88,-230 290.88,-230 290.88,-230 276.33,-230 276.33,-230"/>
<polygon fill="#bdbdbd" stroke="#bdbdbd" points="276.33,-227.55 269.33,-230 276.33,-232.45 276.33,-227.55"/>
<text text-anchor="middle" x="283.17" y="-360.2" font-family="Times,serif" font-size="14.00">REST API</text>
</g>
<!-- sdk -->
<g id="node2" class="node">
<title>sdk</title>
<path fill="#2b2b2b" stroke="black" d="M505.12,-337.5C505.12,-337.5 420.88,-337.5 420.88,-337.5 414.88,-337.5 408.88,-331.5 408.88,-325.5 408.88,-325.5 408.88,-313.5 408.88,-313.5 408.88,-307.5 414.88,-301.5 420.88,-301.5 420.88,-301.5 505.12,-301.5 505.12,-301.5 511.12,-301.5 517.12,-307.5 517.12,-313.5 517.12,-313.5 517.12,-325.5 517.12,-325.5 517.12,-331.5 511.12,-337.5 505.12,-337.5"/>
<text text-anchor="middle" x="463" y="-314.07" font-family="Helvetica,sans-Serif" font-size="14.00" fill="white">woodpecker&#45;go</text>
</g>
<!-- sdk&#45;&gt;srv_api -->
<g id="edge5" class="edge">
<title>sdk&#45;&gt;srv_api</title>
<path fill="none" stroke="#bdbdbd" d="M408.65,-314C360.23,-314 297,-314 297,-314 297,-314 297,-218 297,-218 297,-218 276.25,-218 276.25,-218"/>
<polygon fill="#bdbdbd" stroke="#bdbdbd" points="276.25,-215.55 269.25,-218 276.25,-220.45 276.25,-215.55"/>
<text text-anchor="middle" x="325.88" y="-314.65" font-family="Times,serif" font-size="14.00">REST API</text>
</g>
<!-- cli_cmd -->
<g id="node3" class="node">
<title>cli_cmd</title>
<path fill="#2b2b2b" stroke="black" d="M543.25,-529C543.25,-529 504.75,-529 504.75,-529 498.75,-529 492.75,-523 492.75,-517 492.75,-517 492.75,-505 492.75,-505 492.75,-499 498.75,-493 504.75,-493 504.75,-493 543.25,-493 543.25,-493 549.25,-493 555.25,-499 555.25,-505 555.25,-505 555.25,-517 555.25,-517 555.25,-523 549.25,-529 543.25,-529"/>
<text text-anchor="middle" x="524" y="-505.57" font-family="Helvetica,sans-Serif" font-size="14.00" fill="white">cmd/cli/</text>
</g>
<!-- cli_core -->
<g id="node4" class="node">
<title>cli_core</title>
<path fill="#2b2b2b" stroke="black" d="M539,-433.25C539,-433.25 509,-433.25 509,-433.25 503,-433.25 497,-427.25 497,-421.25 497,-421.25 497,-409.25 497,-409.25 497,-403.25 503,-397.25 509,-397.25 509,-397.25 539,-397.25 539,-397.25 545,-397.25 551,-403.25 551,-409.25 551,-409.25 551,-421.25 551,-421.25 551,-427.25 545,-433.25 539,-433.25"/>
<text text-anchor="middle" x="524" y="-409.82" font-family="Helvetica,sans-Serif" font-size="14.00" fill="white">cli/</text>
</g>
<!-- cli_cmd&#45;&gt;cli_core -->
<g id="edge3" class="edge">
<title>cli_cmd&#45;&gt;cli_core</title>
<path fill="none" stroke="#bdbdbd" d="M524,-492.54C524,-492.54 524,-442.17 524,-442.17"/>
<polygon fill="#bdbdbd" stroke="#bdbdbd" points="526.45,-442.17 524,-435.17 521.55,-442.17 526.45,-442.17"/>
</g>
<!-- cli_core&#45;&gt;sdk -->
<g id="edge4" class="edge">
<title>cli_core&#45;&gt;sdk</title>
<path fill="none" stroke="#bdbdbd" d="M507.06,-396.79C507.06,-396.79 507.06,-346.42 507.06,-346.42"/>
<polygon fill="#bdbdbd" stroke="#bdbdbd" points="509.51,-346.42 507.06,-339.42 504.61,-346.42 509.51,-346.42"/>
</g>
<!-- agent_cmd -->
<g id="node5" class="node">
<title>agent_cmd</title>
<path fill="#2b2b2b" stroke="black" d="M716.75,-433.25C716.75,-433.25 657.25,-433.25 657.25,-433.25 651.25,-433.25 645.25,-427.25 645.25,-421.25 645.25,-421.25 645.25,-409.25 645.25,-409.25 645.25,-403.25 651.25,-397.25 657.25,-397.25 657.25,-397.25 716.75,-397.25 716.75,-397.25 722.75,-397.25 728.75,-403.25 728.75,-409.25 728.75,-409.25 728.75,-421.25 728.75,-421.25 728.75,-427.25 722.75,-433.25 716.75,-433.25"/>
<text text-anchor="middle" x="687" y="-409.82" font-family="Helvetica,sans-Serif" font-size="14.00" fill="white">cmd/agent/</text>
</g>
<!-- agent_core -->
<g id="node6" class="node">
<title>agent_core</title>
<path fill="#2b2b2b" stroke="black" d="M702,-337.5C702,-337.5 672,-337.5 672,-337.5 666,-337.5 660,-331.5 660,-325.5 660,-325.5 660,-313.5 660,-313.5 660,-307.5 666,-301.5 672,-301.5 672,-301.5 702,-301.5 702,-301.5 708,-301.5 714,-307.5 714,-313.5 714,-313.5 714,-325.5 714,-325.5 714,-331.5 708,-337.5 702,-337.5"/>
<text text-anchor="middle" x="687" y="-314.07" font-family="Helvetica,sans-Serif" font-size="14.00" fill="white">agent/</text>
</g>
<!-- agent_cmd&#45;&gt;agent_core -->
<g id="edge6" class="edge">
<title>agent_cmd&#45;&gt;agent_core</title>
<path fill="none" stroke="#bdbdbd" d="M687,-396.79C687,-396.79 687,-346.42 687,-346.42"/>
<polygon fill="#bdbdbd" stroke="#bdbdbd" points="689.45,-346.42 687,-339.42 684.55,-346.42 689.45,-346.42"/>
</g>
<!-- pipe_backend -->
<g id="node9" class="node">
<title>pipe_backend</title>
<path fill="#2b2b2b" stroke="black" d="M921.5,-243.5C921.5,-243.5 824.5,-243.5 824.5,-243.5 818.5,-243.5 812.5,-237.5 812.5,-231.5 812.5,-231.5 812.5,-216 812.5,-216 812.5,-210 818.5,-204 824.5,-204 824.5,-204 921.5,-204 921.5,-204 927.5,-204 933.5,-210 933.5,-216 933.5,-216 933.5,-231.5 933.5,-231.5 933.5,-237.5 927.5,-243.5 921.5,-243.5"/>
<text text-anchor="middle" x="873" y="-226.2" font-family="Helvetica,sans-Serif" font-size="14.00" fill="white">pipeline/backend/</text>
<text text-anchor="middle" x="873" y="-210.45" font-family="Helvetica,sans-Serif" font-size="14.00" fill="white">(exec engines)</text>
</g>
<!-- agent_core&#45;&gt;pipe_backend -->
<g id="edge9" class="edge">
<title>agent_core&#45;&gt;pipe_backend</title>
<path fill="none" stroke="#bdbdbd" d="M706.12,-301.09C706.12,-273.34 706.12,-224 706.12,-224 706.12,-224 803.77,-224 803.77,-224"/>
<polygon fill="#bdbdbd" stroke="#bdbdbd" points="803.77,-226.45 810.77,-224 803.77,-221.55 803.77,-226.45"/>
<text text-anchor="middle" x="680.4" y="-227.2" font-family="Times,serif" font-size="14.00">execute steps</text>
</g>
<!-- srv_grpc -->
<g id="node13" class="node">
<title>srv_grpc</title>
<path fill="#2b2b2b" stroke="black" d="M370.88,-241.75C370.88,-241.75 315.12,-241.75 315.12,-241.75 309.12,-241.75 303.12,-235.75 303.12,-229.75 303.12,-229.75 303.12,-217.75 303.12,-217.75 303.12,-211.75 309.12,-205.75 315.12,-205.75 315.12,-205.75 370.88,-205.75 370.88,-205.75 376.88,-205.75 382.88,-211.75 382.88,-217.75 382.88,-217.75 382.88,-229.75 382.88,-229.75 382.88,-235.75 376.88,-241.75 370.88,-241.75"/>
<text text-anchor="middle" x="343" y="-218.32" font-family="Helvetica,sans-Serif" font-size="14.00" fill="white">server/rpc/</text>
</g>
<!-- agent_core&#45;&gt;srv_grpc -->
<g id="edge7" class="edge">
<title>agent_core&#45;&gt;srv_grpc</title>
<path fill="none" stroke="#bdbdbd" d="M679.12,-301.16C679.12,-275.76 679.12,-233 679.12,-233 679.12,-233 391.72,-233 391.72,-233"/>
<polygon fill="#bdbdbd" stroke="#bdbdbd" points="391.72,-230.55 384.72,-233 391.72,-235.45 391.72,-230.55"/>
<text text-anchor="middle" x="530.5" y="-236.2" font-family="Times,serif" font-size="14.00">gRPC connect</text>
</g>
<!-- srv_queue -->
<g id="node14" class="node">
<title>srv_queue</title>
<path fill="#2b2b2b" stroke="black" d="M371.25,-146C371.25,-146 296.75,-146 296.75,-146 290.75,-146 284.75,-140 284.75,-134 284.75,-134 284.75,-122 284.75,-122 284.75,-116 290.75,-110 296.75,-110 296.75,-110 371.25,-110 371.25,-110 377.25,-110 383.25,-116 383.25,-122 383.25,-122 383.25,-134 383.25,-134 383.25,-140 377.25,-146 371.25,-146"/>
<text text-anchor="middle" x="334" y="-122.58" font-family="Helvetica,sans-Serif" font-size="14.00" fill="white">server/queue/</text>
</g>
<!-- agent_core&#45;&gt;srv_queue -->
<g id="edge8" class="edge">
<title>agent_core&#45;&gt;srv_queue</title>
<path fill="none" stroke="#bdbdbd" d="M659.65,-320C617.06,-320 539.75,-320 539.75,-320 539.75,-320 539.75,-128 539.75,-128 539.75,-128 392.06,-128 392.06,-128"/>
<polygon fill="#bdbdbd" stroke="#bdbdbd" points="392.06,-125.55 385.06,-128 392.06,-130.45 392.06,-125.55"/>
<text text-anchor="middle" x="513.5" y="-213.3" font-family="Times,serif" font-size="14.00">poll work</text>
</g>
<!-- pipe_core -->
<g id="node7" class="node">
<title>pipe_core</title>
<path fill="#2b2b2b" stroke="black" d="M894.12,-337.5C894.12,-337.5 851.88,-337.5 851.88,-337.5 845.88,-337.5 839.88,-331.5 839.88,-325.5 839.88,-325.5 839.88,-313.5 839.88,-313.5 839.88,-307.5 845.88,-301.5 851.88,-301.5 851.88,-301.5 894.12,-301.5 894.12,-301.5 900.12,-301.5 906.12,-307.5 906.12,-313.5 906.12,-313.5 906.12,-325.5 906.12,-325.5 906.12,-331.5 900.12,-337.5 894.12,-337.5"/>
<text text-anchor="middle" x="873" y="-314.07" font-family="Helvetica,sans-Serif" font-size="14.00" fill="white">pipeline/</text>
</g>
<!-- pipe_core&#45;&gt;pipe_backend -->
<g id="edge11" class="edge">
<title>pipe_core&#45;&gt;pipe_backend</title>
<path fill="none" stroke="#bdbdbd" d="M873,-301.04C873,-301.04 873,-252.32 873,-252.32"/>
<polygon fill="#bdbdbd" stroke="#bdbdbd" points="875.45,-252.32 873,-245.32 870.55,-252.32 875.45,-252.32"/>
</g>
<!-- shared_util -->
<g id="node19" class="node">
<title>shared_util</title>
<path fill="#2b2b2b" stroke="black" d="M1076,-146C1076,-146 1018,-146 1018,-146 1012,-146 1006,-140 1006,-134 1006,-134 1006,-122 1006,-122 1006,-116 1012,-110 1018,-110 1018,-110 1076,-110 1076,-110 1082,-110 1088,-116 1088,-122 1088,-122 1088,-134 1088,-134 1088,-140 1082,-146 1076,-146"/>
<text text-anchor="middle" x="1047" y="-122.58" font-family="Helvetica,sans-Serif" font-size="14.00" fill="white">shared/util/</text>
</g>
<!-- pipe_core&#45;&gt;shared_util -->
<g id="edge24" class="edge">
<title>pipe_core&#45;&gt;shared_util</title>
<path fill="none" stroke="#bdbdbd" d="M906.55,-320C957.11,-320 1047,-320 1047,-320 1047,-320 1047,-154.92 1047,-154.92"/>
<polygon fill="#bdbdbd" stroke="#bdbdbd" points="1049.45,-154.92 1047,-147.92 1044.55,-154.92 1049.45,-154.92"/>
</g>
<!-- pipe_frontend -->
<g id="node8" class="node">
<title>pipe_frontend</title>
<path fill="#2b2b2b" stroke="black" d="M920.75,-435C920.75,-435 825.25,-435 825.25,-435 819.25,-435 813.25,-429 813.25,-423 813.25,-423 813.25,-407.5 813.25,-407.5 813.25,-401.5 819.25,-395.5 825.25,-395.5 825.25,-395.5 920.75,-395.5 920.75,-395.5 926.75,-395.5 932.75,-401.5 932.75,-407.5 932.75,-407.5 932.75,-423 932.75,-423 932.75,-429 926.75,-435 920.75,-435"/>
<text text-anchor="middle" x="873" y="-417.7" font-family="Helvetica,sans-Serif" font-size="14.00" fill="white">pipeline/frontend/</text>
<text text-anchor="middle" x="873" y="-401.95" font-family="Helvetica,sans-Serif" font-size="14.00" fill="white">(yaml)</text>
</g>
<!-- pipe_frontend&#45;&gt;pipe_core -->
<g id="edge10" class="edge">
<title>pipe_frontend&#45;&gt;pipe_core</title>
<path fill="none" stroke="#bdbdbd" d="M873,-395.41C873,-395.41 873,-346.21 873,-346.21"/>
<polygon fill="#bdbdbd" stroke="#bdbdbd" points="875.45,-346.21 873,-339.21 870.55,-346.21 875.45,-346.21"/>
</g>
<!-- srv_cmd -->
<g id="node10" class="node">
<title>srv_cmd</title>
<path fill="#2b2b2b" stroke="black" d="M230.62,-433.25C230.62,-433.25 167.38,-433.25 167.38,-433.25 161.38,-433.25 155.38,-427.25 155.38,-421.25 155.38,-421.25 155.38,-409.25 155.38,-409.25 155.38,-403.25 161.38,-397.25 167.38,-397.25 167.38,-397.25 230.62,-397.25 230.62,-397.25 236.62,-397.25 242.62,-403.25 242.62,-409.25 242.62,-409.25 242.62,-421.25 242.62,-421.25 242.62,-427.25 236.62,-433.25 230.62,-433.25"/>
<text text-anchor="middle" x="199" y="-409.82" font-family="Helvetica,sans-Serif" font-size="14.00" fill="white">cmd/server/</text>
</g>
<!-- srv_cmd&#45;&gt;srv_router -->
<g id="edge12" class="edge">
<title>srv_cmd&#45;&gt;srv_router</title>
<path fill="none" stroke="#bdbdbd" d="M213.75,-396.79C213.75,-396.79 213.75,-346.42 213.75,-346.42"/>
<polygon fill="#bdbdbd" stroke="#bdbdbd" points="216.2,-346.42 213.75,-339.42 211.3,-346.42 216.2,-346.42"/>
</g>
<!-- srv_router&#45;&gt;srv_api -->
<g id="edge13" class="edge">
<title>srv_router&#45;&gt;srv_api</title>
<path fill="none" stroke="#bdbdbd" d="M228,-301.04C228,-301.04 228,-250.67 228,-250.67"/>
<polygon fill="#bdbdbd" stroke="#bdbdbd" points="230.45,-250.67 228,-243.67 225.55,-250.67 230.45,-250.67"/>
</g>
<!-- shared_token -->
<g id="node20" class="node">
<title>shared_token</title>
<path fill="#2b2b2b" stroke="black" d="M957.88,-146C957.88,-146 884.12,-146 884.12,-146 878.12,-146 872.12,-140 872.12,-134 872.12,-134 872.12,-122 872.12,-122 872.12,-116 878.12,-110 884.12,-110 884.12,-110 957.88,-110 957.88,-110 963.88,-110 969.88,-116 969.88,-122 969.88,-122 969.88,-134 969.88,-134 969.88,-140 963.88,-146 957.88,-146"/>
<text text-anchor="middle" x="921" y="-122.58" font-family="Helvetica,sans-Serif" font-size="14.00" fill="white">shared/token/</text>
</g>
<!-- srv_router&#45;&gt;shared_token -->
<g id="edge21" class="edge">
<title>srv_router&#45;&gt;shared_token</title>
<path fill="none" stroke="#bdbdbd" d="M274.31,-301.08C274.31,-264.24 274.31,-185 274.31,-185 274.31,-185 902.81,-185 902.81,-185 902.81,-185 902.81,-154.86 902.81,-154.86"/>
<polygon fill="#bdbdbd" stroke="#bdbdbd" points="905.26,-154.86 902.81,-147.86 900.36,-154.86 905.26,-154.86"/>
</g>
<!-- srv_api&#45;&gt;srv_queue -->
<g id="edge16" class="edge">
<title>srv_api&#45;&gt;srv_queue</title>
<path fill="none" stroke="#bdbdbd" d="M259.88,-205.59C259.88,-179.36 259.88,-134 259.88,-134 259.88,-134 276.04,-134 276.04,-134"/>
<polygon fill="#bdbdbd" stroke="#bdbdbd" points="276.04,-136.45 283.04,-134 276.04,-131.55 276.04,-136.45"/>
</g>
<!-- srv_pubsub -->
<g id="node15" class="node">
<title>srv_pubsub</title>
<path fill="#2b2b2b" stroke="black" d="M109.62,-146C109.62,-146 28.38,-146 28.38,-146 22.38,-146 16.38,-140 16.38,-134 16.38,-134 16.38,-122 16.38,-122 16.38,-116 22.38,-110 28.38,-110 28.38,-110 109.62,-110 109.62,-110 115.62,-110 121.62,-116 121.62,-122 121.62,-122 121.62,-134 121.62,-134 121.62,-140 115.62,-146 109.62,-146"/>
<text text-anchor="middle" x="69" y="-122.58" font-family="Helvetica,sans-Serif" font-size="14.00" fill="white">server/pubsub/</text>
</g>
<!-- srv_api&#45;&gt;srv_pubsub -->
<g id="edge15" class="edge">
<title>srv_api&#45;&gt;srv_pubsub</title>
<path fill="none" stroke="#bdbdbd" d="M188.29,-224C141.19,-224 69,-224 69,-224 69,-224 69,-154.57 69,-154.57"/>
<polygon fill="#bdbdbd" stroke="#bdbdbd" points="71.45,-154.57 69,-147.57 66.55,-154.57 71.45,-154.57"/>
</g>
<!-- srv_store -->
<g id="node16" class="node">
<title>srv_store</title>
<path fill="#2b2b2b" stroke="black" d="M236.5,-146C236.5,-146 169.5,-146 169.5,-146 163.5,-146 157.5,-140 157.5,-134 157.5,-134 157.5,-122 157.5,-122 157.5,-116 163.5,-110 169.5,-110 169.5,-110 236.5,-110 236.5,-110 242.5,-110 248.5,-116 248.5,-122 248.5,-122 248.5,-134 248.5,-134 248.5,-140 242.5,-146 236.5,-146"/>
<text text-anchor="middle" x="203" y="-122.58" font-family="Helvetica,sans-Serif" font-size="14.00" fill="white">server/store/</text>
</g>
<!-- srv_api&#45;&gt;srv_store -->
<g id="edge14" class="edge">
<title>srv_api&#45;&gt;srv_store</title>
<path fill="none" stroke="#bdbdbd" d="M218.5,-205.29C218.5,-205.29 218.5,-154.92 218.5,-154.92"/>
<polygon fill="#bdbdbd" stroke="#bdbdbd" points="220.95,-154.92 218.5,-147.92 216.05,-154.92 220.95,-154.92"/>
</g>
<!-- shared_http -->
<g id="node21" class="node">
<title>shared_http</title>
<path fill="#2b2b2b" stroke="black" d="M686.25,-146C686.25,-146 605.75,-146 605.75,-146 599.75,-146 593.75,-140 593.75,-134 593.75,-134 593.75,-122 593.75,-122 593.75,-116 599.75,-110 605.75,-110 605.75,-110 686.25,-110 686.25,-110 692.25,-110 698.25,-116 698.25,-122 698.25,-122 698.25,-134 698.25,-134 698.25,-140 692.25,-146 686.25,-146"/>
<text text-anchor="middle" x="646" y="-122.58" font-family="Helvetica,sans-Serif" font-size="14.00" fill="white">shared/httputil/</text>
</g>
<!-- srv_api&#45;&gt;shared_http -->
<g id="edge22" class="edge">
<title>srv_api&#45;&gt;shared_http</title>
<path fill="none" stroke="#bdbdbd" d="M263.69,-205.48C263.69,-188.24 263.69,-165 263.69,-165 263.69,-165 619.5,-165 619.5,-165 619.5,-165 619.5,-155.01 619.5,-155.01"/>
<polygon fill="#bdbdbd" stroke="#bdbdbd" points="621.95,-155.01 619.5,-148.01 617.05,-155.01 621.95,-155.01"/>
</g>
<!-- srv_grpc&#45;&gt;srv_queue -->
<g id="edge17" class="edge">
<title>srv_grpc&#45;&gt;srv_queue</title>
<path fill="none" stroke="#bdbdbd" d="M343,-205.29C343,-205.29 343,-154.92 343,-154.92"/>
<polygon fill="#bdbdbd" stroke="#bdbdbd" points="345.45,-154.92 343,-147.92 340.55,-154.92 345.45,-154.92"/>
</g>
<!-- shared_log -->
<g id="node22" class="node">
<title>shared_log</title>
<path fill="#2b2b2b" stroke="black" d="M824.12,-146C824.12,-146 745.88,-146 745.88,-146 739.88,-146 733.88,-140 733.88,-134 733.88,-134 733.88,-122 733.88,-122 733.88,-116 739.88,-110 745.88,-110 745.88,-110 824.12,-110 824.12,-110 830.12,-110 836.12,-116 836.12,-122 836.12,-122 836.12,-134 836.12,-134 836.12,-140 830.12,-146 824.12,-146"/>
<text text-anchor="middle" x="785" y="-122.58" font-family="Helvetica,sans-Serif" font-size="14.00" fill="white">shared/logger/</text>
</g>
<!-- srv_grpc&#45;&gt;shared_log -->
<g id="edge23" class="edge">
<title>srv_grpc&#45;&gt;shared_log</title>
<path fill="none" stroke="#bdbdbd" d="M383.08,-215C489.88,-215 773.19,-215 773.19,-215 773.19,-215 773.19,-154.96 773.19,-154.96"/>
<polygon fill="#bdbdbd" stroke="#bdbdbd" points="775.64,-154.96 773.19,-147.96 770.74,-154.96 775.64,-154.96"/>
</g>
<!-- srv_model -->
<g id="node17" class="node">
<title>srv_model</title>
<path fill="#2b2b2b" stroke="black" d="M240.25,-52C240.25,-52 165.75,-52 165.75,-52 159.75,-52 153.75,-46 153.75,-40 153.75,-40 153.75,-28 153.75,-28 153.75,-22 159.75,-16 165.75,-16 165.75,-16 240.25,-16 240.25,-16 246.25,-16 252.25,-22 252.25,-28 252.25,-28 252.25,-40 252.25,-40 252.25,-46 246.25,-52 240.25,-52"/>
<text text-anchor="middle" x="203" y="-28.57" font-family="Helvetica,sans-Serif" font-size="14.00" fill="white">server/model/</text>
</g>
<!-- srv_store&#45;&gt;srv_model -->
<g id="edge18" class="edge">
<title>srv_store&#45;&gt;srv_model</title>
<path fill="none" stroke="#bdbdbd" d="M203,-109.88C203,-109.88 203,-60.9 203,-60.9"/>
<polygon fill="#bdbdbd" stroke="#bdbdbd" points="205.45,-60.9 203,-53.9 200.55,-60.9 205.45,-60.9"/>
</g>
<!-- ext_db -->
<g id="node24" class="node">
<title>ext_db</title>
<path fill="#2b2b2b" stroke="black" d="M480.88,-48.73C480.88,-50.53 464.35,-52 444,-52 423.65,-52 407.12,-50.53 407.12,-48.73 407.12,-48.73 407.12,-19.27 407.12,-19.27 407.12,-17.47 423.65,-16 444,-16 464.35,-16 480.88,-17.47 480.88,-19.27 480.88,-19.27 480.88,-48.73 480.88,-48.73"/>
<path fill="none" stroke="black" d="M480.88,-48.73C480.88,-46.92 464.35,-45.45 444,-45.45 423.65,-45.45 407.12,-46.92 407.12,-48.73"/>
<text text-anchor="middle" x="444" y="-28.57" font-family="Helvetica,sans-Serif" font-size="14.00" fill="white">Database</text>
</g>
<!-- srv_store&#45;&gt;ext_db -->
<g id="edge20" class="edge">
<title>srv_store&#45;&gt;ext_db</title>
<path fill="none" stroke="#bdbdbd" d="M248.68,-122C253.15,-122 256.06,-122 256.06,-122 256.06,-122 256.06,-34 256.06,-34 256.06,-34 398.36,-34 398.36,-34"/>
<polygon fill="#bdbdbd" stroke="#bdbdbd" points="398.36,-36.45 405.36,-34 398.36,-31.55 398.36,-36.45"/>
<text text-anchor="middle" x="266.77" y="-37.2" font-family="Times,serif" font-size="14.00">SQL</text>
</g>
<!-- srv_forge -->
<g id="node18" class="node">
<title>srv_forge</title>
<path fill="#2b2b2b" stroke="black" d="M358.88,-433.25C358.88,-433.25 291.12,-433.25 291.12,-433.25 285.12,-433.25 279.12,-427.25 279.12,-421.25 279.12,-421.25 279.12,-409.25 279.12,-409.25 279.12,-403.25 285.12,-397.25 291.12,-397.25 291.12,-397.25 358.88,-397.25 358.88,-397.25 364.88,-397.25 370.88,-403.25 370.88,-409.25 370.88,-409.25 370.88,-421.25 370.88,-421.25 370.88,-427.25 364.88,-433.25 358.88,-433.25"/>
<text text-anchor="middle" x="325" y="-409.82" font-family="Helvetica,sans-Serif" font-size="14.00" fill="white">server/forge/</text>
</g>
<!-- ext_scm -->
<g id="node23" class="node">
<title>ext_scm</title>
<path fill="#2b2b2b" stroke="black" d="M612.75,-52C612.75,-52 529.25,-52 529.25,-52 523.25,-52 517.25,-46 517.25,-40 517.25,-40 517.25,-28 517.25,-28 517.25,-22 523.25,-16 529.25,-16 529.25,-16 612.75,-16 612.75,-16 618.75,-16 624.75,-22 624.75,-28 624.75,-28 624.75,-40 624.75,-40 624.75,-46 618.75,-52 612.75,-52"/>
<text text-anchor="middle" x="571" y="-28.57" font-family="Helvetica,sans-Serif" font-size="14.00" fill="white">SCM Providers</text>
</g>
<!-- srv_forge&#45;&gt;ext_scm -->
<g id="edge19" class="edge">
<title>srv_forge&#45;&gt;ext_scm</title>
<path fill="none" stroke="#bdbdbd" d="M337,-397C337,-386.75 337,-376 337,-376 337,-376 528.5,-376 528.5,-376 528.5,-376 528.5,-60.9 528.5,-60.9"/>
<polygon fill="#bdbdbd" stroke="#bdbdbd" points="530.95,-60.9 528.5,-53.9 526.05,-60.9 530.95,-60.9"/>
<text text-anchor="middle" x="555.5" y="-327.9" font-family="Times,serif" font-size="14.00">SCM API</text>
</g>
</g>
</svg>

After

Width:  |  Height:  |  Size: 27 KiB

+1 -1
View File
@@ -1 +1 @@
["3.13", "3.12", "3.11", "2.8"]
["3.14", "3.13", "3.12", "2.8"]