From 551fc0dd8e48abe96c9c35452db0ab383d93b594 Mon Sep 17 00:00:00 2001 From: qwerty287 <80460567+qwerty287@users.noreply.github.com> Date: Sat, 5 Jul 2025 13:44:20 +0300 Subject: [PATCH] Add 3.8 docs (#5303) --- .../10-intro/index.md | 0 .../20-usage/10-intro.md | 0 .../20-usage/100-troubleshooting.md | 0 .../15-terminology/architecture.excalidraw | 0 .../20-usage/15-terminology/architecture.svg | 0 .../20-usage/15-terminology/index.md | 0 .../pipeline-workflow-step.excalidraw | 0 .../15-terminology/pipeline-workflow-step.svg | 0 .../20-usage/20-workflow-syntax.md | 13 +- .../20-usage/25-workflows.md | 0 .../20-usage/30-matrix-workflows.md | 0 .../20-usage/40-secrets.md | 0 .../20-usage/41-registries.md | 0 .../20-usage/45-cron.md | 0 .../20-usage/50-environment.md | 6 +- .../51-plugins/20-creating-plugins.md | 0 .../20-usage/51-plugins/51-overview.md | 1 + .../20-usage/51-plugins/_category_.yaml | 0 .../20-usage/60-services.md | 0 .../20-usage/70-volumes.md | 0 .../20-usage/72-linter.md | 0 .../20-usage/75-project-settings.md | 0 .../20-usage/80-badges.md | 0 .../20-usage/90-advanced-usage.md | 0 .../20-usage/_category_.yaml | 0 .../20-usage/cron-settings.png | Bin .../20-usage/linter-warnings-errors.png | Bin .../20-usage/pipeline.png | Bin .../20-usage/project-settings.png | Bin .../20-usage/repo-new.png | Bin .../20-usage/secrets-plugins-filter.png | Bin .../30-administration/00-general.md | 0 .../05-installation/10-docker-compose.md | 0 .../05-installation/20-helm-chart.md | 0 .../05-installation/30-packages.md | 2 +- .../05-installation/_category_.yaml | 0 .../10-configuration/10-server.md | 0 .../10-configuration/11-backends/10-docker.md | 0 .../11-backends/20-kubernetes.md | 0 .../10-configuration/11-backends/30-local.md | 0 .../10-configuration/11-backends/50-custom.md | 0 .../11-backends/_category_.yaml | 0 .../10-configuration/12-forges/100-addon.md | 0 .../10-configuration/12-forges/11-overview.md | 2 +- .../10-configuration/12-forges/20-github.md | 0 .../10-configuration/12-forges/30-gitea.md | 0 .../10-configuration/12-forges/35-forgejo.md | 0 .../10-configuration/12-forges/40-gitlab.md | 0 .../12-forges/50-bitbucket.md | 0 .../12-forges/60-bitbucket_datacenter.md | 0 .../12-forges/_category_.yaml | 0 .../12-forges/bitbucket_oauth.png | Bin .../12-forges/bitbucket_permissions.png | Bin .../12-forges/gitea_oauth.gif | Bin .../12-forges/github_oauth.png | Bin .../10-configuration/30-agent.md | 0 .../10-configuration/40-autoscaler.md | 0 .../10-configuration/_category_.yaml | 0 .../10-configuration/new-agent-connected.png | Bin .../10-configuration/new-agent-created.png | Bin .../new-agent-registration.png | Bin .../30-administration/_category_.yaml | 0 .../{version-3.5 => version-3.8}/40-cli.md | 1008 ++++++++++------- .../92-development/01-getting-started.md | 0 .../92-development/02-core-ideas.md | 0 .../92-development/03-ui.md | 0 .../92-development/04-docs.md | 0 .../92-development/05-architecture.md | 0 .../92-development/06-conventions.md | 0 .../92-development/07-guides.md | 0 .../92-development/08-translations.md | 0 .../92-development/09-openapi.md | 0 .../92-development/09-testing.md | 0 .../92-development/_category_.yaml | 0 .../92-development/ui-proxy.svg | 0 .../92-development/vscode-debug.png | Bin .../92-development/vscode-run-test.png | Bin .../woodpecker-architecture.png | Bin ...idebars.json => version-3.8-sidebars.json} | 0 docs/versions.json | 2 +- 80 files changed, 619 insertions(+), 415 deletions(-) rename docs/versioned_docs/{version-3.5 => version-3.8}/10-intro/index.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/20-usage/10-intro.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/20-usage/100-troubleshooting.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/20-usage/15-terminology/architecture.excalidraw (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/20-usage/15-terminology/architecture.svg (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/20-usage/15-terminology/index.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/20-usage/15-terminology/pipeline-workflow-step.excalidraw (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/20-usage/15-terminology/pipeline-workflow-step.svg (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/20-usage/20-workflow-syntax.md (98%) rename docs/versioned_docs/{version-3.5 => version-3.8}/20-usage/25-workflows.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/20-usage/30-matrix-workflows.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/20-usage/40-secrets.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/20-usage/41-registries.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/20-usage/45-cron.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/20-usage/50-environment.md (97%) rename docs/versioned_docs/{version-3.5 => version-3.8}/20-usage/51-plugins/20-creating-plugins.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/20-usage/51-plugins/51-overview.md (96%) rename docs/versioned_docs/{version-3.5 => version-3.8}/20-usage/51-plugins/_category_.yaml (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/20-usage/60-services.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/20-usage/70-volumes.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/20-usage/72-linter.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/20-usage/75-project-settings.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/20-usage/80-badges.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/20-usage/90-advanced-usage.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/20-usage/_category_.yaml (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/20-usage/cron-settings.png (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/20-usage/linter-warnings-errors.png (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/20-usage/pipeline.png (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/20-usage/project-settings.png (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/20-usage/repo-new.png (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/20-usage/secrets-plugins-filter.png (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/30-administration/00-general.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/30-administration/05-installation/10-docker-compose.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/30-administration/05-installation/20-helm-chart.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/30-administration/05-installation/30-packages.md (98%) rename docs/versioned_docs/{version-3.5 => version-3.8}/30-administration/05-installation/_category_.yaml (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/30-administration/10-configuration/10-server.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/30-administration/10-configuration/11-backends/10-docker.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/30-administration/10-configuration/11-backends/20-kubernetes.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/30-administration/10-configuration/11-backends/30-local.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/30-administration/10-configuration/11-backends/50-custom.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/30-administration/10-configuration/11-backends/_category_.yaml (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/30-administration/10-configuration/12-forges/100-addon.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/30-administration/10-configuration/12-forges/11-overview.md (96%) rename docs/versioned_docs/{version-3.5 => version-3.8}/30-administration/10-configuration/12-forges/20-github.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/30-administration/10-configuration/12-forges/30-gitea.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/30-administration/10-configuration/12-forges/35-forgejo.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/30-administration/10-configuration/12-forges/40-gitlab.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/30-administration/10-configuration/12-forges/50-bitbucket.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/30-administration/10-configuration/12-forges/60-bitbucket_datacenter.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/30-administration/10-configuration/12-forges/_category_.yaml (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/30-administration/10-configuration/12-forges/bitbucket_oauth.png (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/30-administration/10-configuration/12-forges/bitbucket_permissions.png (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/30-administration/10-configuration/12-forges/gitea_oauth.gif (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/30-administration/10-configuration/12-forges/github_oauth.png (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/30-administration/10-configuration/30-agent.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/30-administration/10-configuration/40-autoscaler.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/30-administration/10-configuration/_category_.yaml (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/30-administration/10-configuration/new-agent-connected.png (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/30-administration/10-configuration/new-agent-created.png (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/30-administration/10-configuration/new-agent-registration.png (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/30-administration/_category_.yaml (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/40-cli.md (73%) rename docs/versioned_docs/{version-3.5 => version-3.8}/92-development/01-getting-started.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/92-development/02-core-ideas.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/92-development/03-ui.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/92-development/04-docs.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/92-development/05-architecture.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/92-development/06-conventions.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/92-development/07-guides.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/92-development/08-translations.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/92-development/09-openapi.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/92-development/09-testing.md (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/92-development/_category_.yaml (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/92-development/ui-proxy.svg (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/92-development/vscode-debug.png (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/92-development/vscode-run-test.png (100%) rename docs/versioned_docs/{version-3.5 => version-3.8}/92-development/woodpecker-architecture.png (100%) rename docs/versioned_sidebars/{version-3.5-sidebars.json => version-3.8-sidebars.json} (100%) diff --git a/docs/versioned_docs/version-3.5/10-intro/index.md b/docs/versioned_docs/version-3.8/10-intro/index.md similarity index 100% rename from docs/versioned_docs/version-3.5/10-intro/index.md rename to docs/versioned_docs/version-3.8/10-intro/index.md diff --git a/docs/versioned_docs/version-3.5/20-usage/10-intro.md b/docs/versioned_docs/version-3.8/20-usage/10-intro.md similarity index 100% rename from docs/versioned_docs/version-3.5/20-usage/10-intro.md rename to docs/versioned_docs/version-3.8/20-usage/10-intro.md diff --git a/docs/versioned_docs/version-3.5/20-usage/100-troubleshooting.md b/docs/versioned_docs/version-3.8/20-usage/100-troubleshooting.md similarity index 100% rename from docs/versioned_docs/version-3.5/20-usage/100-troubleshooting.md rename to docs/versioned_docs/version-3.8/20-usage/100-troubleshooting.md diff --git a/docs/versioned_docs/version-3.5/20-usage/15-terminology/architecture.excalidraw b/docs/versioned_docs/version-3.8/20-usage/15-terminology/architecture.excalidraw similarity index 100% rename from docs/versioned_docs/version-3.5/20-usage/15-terminology/architecture.excalidraw rename to docs/versioned_docs/version-3.8/20-usage/15-terminology/architecture.excalidraw diff --git a/docs/versioned_docs/version-3.5/20-usage/15-terminology/architecture.svg b/docs/versioned_docs/version-3.8/20-usage/15-terminology/architecture.svg similarity index 100% rename from docs/versioned_docs/version-3.5/20-usage/15-terminology/architecture.svg rename to docs/versioned_docs/version-3.8/20-usage/15-terminology/architecture.svg diff --git a/docs/versioned_docs/version-3.5/20-usage/15-terminology/index.md b/docs/versioned_docs/version-3.8/20-usage/15-terminology/index.md similarity index 100% rename from docs/versioned_docs/version-3.5/20-usage/15-terminology/index.md rename to docs/versioned_docs/version-3.8/20-usage/15-terminology/index.md diff --git a/docs/versioned_docs/version-3.5/20-usage/15-terminology/pipeline-workflow-step.excalidraw b/docs/versioned_docs/version-3.8/20-usage/15-terminology/pipeline-workflow-step.excalidraw similarity index 100% rename from docs/versioned_docs/version-3.5/20-usage/15-terminology/pipeline-workflow-step.excalidraw rename to docs/versioned_docs/version-3.8/20-usage/15-terminology/pipeline-workflow-step.excalidraw diff --git a/docs/versioned_docs/version-3.5/20-usage/15-terminology/pipeline-workflow-step.svg b/docs/versioned_docs/version-3.8/20-usage/15-terminology/pipeline-workflow-step.svg similarity index 100% rename from docs/versioned_docs/version-3.5/20-usage/15-terminology/pipeline-workflow-step.svg rename to docs/versioned_docs/version-3.8/20-usage/15-terminology/pipeline-workflow-step.svg diff --git a/docs/versioned_docs/version-3.5/20-usage/20-workflow-syntax.md b/docs/versioned_docs/version-3.8/20-usage/20-workflow-syntax.md similarity index 98% rename from docs/versioned_docs/version-3.5/20-usage/20-workflow-syntax.md rename to docs/versioned_docs/version-3.8/20-usage/20-workflow-syntax.md index 58b523265..7971876e7 100644 --- a/docs/versioned_docs/version-3.5/20-usage/20-workflow-syntax.md +++ b/docs/versioned_docs/version-3.8/20-usage/20-workflow-syntax.md @@ -122,7 +122,13 @@ image: index.docker.io/library/golang image: index.docker.io/library/golang:1.7 ``` -Woodpecker does not automatically upgrade container images. Example configuration to always pull the latest image when updates are available: +Learn more how you can use images from [different registries](./41-registries.md). + +### `pull` + +By default, Woodpecker does not automatically upgrade container images and only pulls them when they are not already present. + +To always pull the latest image when updates are available, use the `pull` option: ```diff steps: @@ -131,8 +137,6 @@ Woodpecker does not automatically upgrade container images. Example configuratio + pull: true ``` -Learn more how you can use images from [different registries](./41-registries.md). - ### `commands` Commands of every step are executed serially as if you would enter them into your local shell. @@ -389,8 +393,7 @@ when: #### `path` :::info -Path conditions are applied only to **push** and **pull_request** events. -It is currently **only available** for GitHub, GitLab and Gitea (version 1.18.0 and newer) +Path conditions are applied only to **push** and **pull_request** events. This feature is currently available for all forges except Bitbucket Cloud. ::: Execute a step only on a pipeline with certain files being changed: diff --git a/docs/versioned_docs/version-3.5/20-usage/25-workflows.md b/docs/versioned_docs/version-3.8/20-usage/25-workflows.md similarity index 100% rename from docs/versioned_docs/version-3.5/20-usage/25-workflows.md rename to docs/versioned_docs/version-3.8/20-usage/25-workflows.md diff --git a/docs/versioned_docs/version-3.5/20-usage/30-matrix-workflows.md b/docs/versioned_docs/version-3.8/20-usage/30-matrix-workflows.md similarity index 100% rename from docs/versioned_docs/version-3.5/20-usage/30-matrix-workflows.md rename to docs/versioned_docs/version-3.8/20-usage/30-matrix-workflows.md diff --git a/docs/versioned_docs/version-3.5/20-usage/40-secrets.md b/docs/versioned_docs/version-3.8/20-usage/40-secrets.md similarity index 100% rename from docs/versioned_docs/version-3.5/20-usage/40-secrets.md rename to docs/versioned_docs/version-3.8/20-usage/40-secrets.md diff --git a/docs/versioned_docs/version-3.5/20-usage/41-registries.md b/docs/versioned_docs/version-3.8/20-usage/41-registries.md similarity index 100% rename from docs/versioned_docs/version-3.5/20-usage/41-registries.md rename to docs/versioned_docs/version-3.8/20-usage/41-registries.md diff --git a/docs/versioned_docs/version-3.5/20-usage/45-cron.md b/docs/versioned_docs/version-3.8/20-usage/45-cron.md similarity index 100% rename from docs/versioned_docs/version-3.5/20-usage/45-cron.md rename to docs/versioned_docs/version-3.8/20-usage/45-cron.md diff --git a/docs/versioned_docs/version-3.5/20-usage/50-environment.md b/docs/versioned_docs/version-3.8/20-usage/50-environment.md similarity index 97% rename from docs/versioned_docs/version-3.5/20-usage/50-environment.md rename to docs/versioned_docs/version-3.8/20-usage/50-environment.md index 746cb7634..5ef8553c4 100644 --- a/docs/versioned_docs/version-3.5/20-usage/50-environment.md +++ b/docs/versioned_docs/version-3.8/20-usage/50-environment.md @@ -77,7 +77,6 @@ This is the reference list of all environment variables available to your pipeli | `CI_COMMIT_MESSAGE` | commit message | `Initial commit` | | `CI_COMMIT_AUTHOR` | commit author username | `john-doe` | | `CI_COMMIT_AUTHOR_EMAIL` | commit author email address | `john-doe@example.com` | -| `CI_COMMIT_AUTHOR_AVATAR` | commit author avatar | `https://git.example.com/avatars/5dcbcadbce6f87f8abef` | | `CI_COMMIT_PRERELEASE` | release is a pre-release (empty if event is not `release`) | `false` | | | **Current pipeline** | | | `CI_PIPELINE_NUMBER` | pipeline number | `8` | @@ -90,6 +89,8 @@ This is the reference list of all environment variables available to your pipeli | `CI_PIPELINE_CREATED` | pipeline created UNIX timestamp | `1722617519` | | `CI_PIPELINE_STARTED` | pipeline started UNIX timestamp | `1722617519` | | `CI_PIPELINE_FILES` | changed files (empty if event is not `push` or `pull_request`), it is undefined if more than 500 files are touched | `[]`, `[".woodpecker.yml","README.md"]` | +| `CI_PIPELINE_AUTHOR` | pipeline author username | `octocat` | +| `CI_PIPELINE_AVATAR` | pipeline author avatar | `https://git.example.com/avatars/5dcbcadbce6f87f8abef` | | | **Current workflow** | | | `CI_WORKFLOW_NAME` | workflow name | `release` | | | **Current step** | | @@ -108,7 +109,6 @@ This is the reference list of all environment variables available to your pipeli | `CI_PREV_COMMIT_MESSAGE` | previous commit message | `test` | | `CI_PREV_COMMIT_AUTHOR` | previous commit author username | `john-doe` | | `CI_PREV_COMMIT_AUTHOR_EMAIL` | previous commit author email address | `john-doe@example.com` | -| `CI_PREV_COMMIT_AUTHOR_AVATAR` | previous commit author avatar | `https://git.example.com/avatars/12` | | | **Previous pipeline** | | | `CI_PREV_PIPELINE_NUMBER` | previous pipeline number | `7` | | `CI_PREV_PIPELINE_PARENT` | previous pipeline number of parent pipeline | `0` | @@ -121,6 +121,8 @@ This is the reference list of all environment variables available to your pipeli | `CI_PREV_PIPELINE_CREATED` | previous pipeline created UNIX timestamp | `1722610173` | | `CI_PREV_PIPELINE_STARTED` | previous pipeline started UNIX timestamp | `1722610173` | | `CI_PREV_PIPELINE_FINISHED` | previous pipeline finished UNIX timestamp | `1722610383` | +| `CI_PREV_PIPELINE_AUTHOR` | previous pipeline author username | `octocat` | +| `CI_PREV_PIPELINE_AVATAR` | previous pipeline author avatar | `https://git.example.com/avatars/5dcbcadbce6f87f8abef` | | |   | | | `CI_WORKSPACE` | Path of the workspace where source code gets cloned to | `/woodpecker/src/git.example.com/john-doe/my-repo` | | | **System** | | diff --git a/docs/versioned_docs/version-3.5/20-usage/51-plugins/20-creating-plugins.md b/docs/versioned_docs/version-3.8/20-usage/51-plugins/20-creating-plugins.md similarity index 100% rename from docs/versioned_docs/version-3.5/20-usage/51-plugins/20-creating-plugins.md rename to docs/versioned_docs/version-3.8/20-usage/51-plugins/20-creating-plugins.md diff --git a/docs/versioned_docs/version-3.5/20-usage/51-plugins/51-overview.md b/docs/versioned_docs/version-3.8/20-usage/51-plugins/51-overview.md similarity index 96% rename from docs/versioned_docs/version-3.5/20-usage/51-plugins/51-overview.md rename to docs/versioned_docs/version-3.8/20-usage/51-plugins/51-overview.md index 7da822a47..a731a7e97 100644 --- a/docs/versioned_docs/version-3.5/20-usage/51-plugins/51-overview.md +++ b/docs/versioned_docs/version-3.8/20-usage/51-plugins/51-overview.md @@ -64,5 +64,6 @@ There are also other plugin lists with additional plugins. Keep in mind that [Dr - [Drone Plugins](http://plugins.drone.io) - [Geeklab Woodpecker Plugins](https://woodpecker-plugins.geekdocs.de/) +- [Woodpecker Community Plugins](https://codeberg.org/woodpecker-community) ::: diff --git a/docs/versioned_docs/version-3.5/20-usage/51-plugins/_category_.yaml b/docs/versioned_docs/version-3.8/20-usage/51-plugins/_category_.yaml similarity index 100% rename from docs/versioned_docs/version-3.5/20-usage/51-plugins/_category_.yaml rename to docs/versioned_docs/version-3.8/20-usage/51-plugins/_category_.yaml diff --git a/docs/versioned_docs/version-3.5/20-usage/60-services.md b/docs/versioned_docs/version-3.8/20-usage/60-services.md similarity index 100% rename from docs/versioned_docs/version-3.5/20-usage/60-services.md rename to docs/versioned_docs/version-3.8/20-usage/60-services.md diff --git a/docs/versioned_docs/version-3.5/20-usage/70-volumes.md b/docs/versioned_docs/version-3.8/20-usage/70-volumes.md similarity index 100% rename from docs/versioned_docs/version-3.5/20-usage/70-volumes.md rename to docs/versioned_docs/version-3.8/20-usage/70-volumes.md diff --git a/docs/versioned_docs/version-3.5/20-usage/72-linter.md b/docs/versioned_docs/version-3.8/20-usage/72-linter.md similarity index 100% rename from docs/versioned_docs/version-3.5/20-usage/72-linter.md rename to docs/versioned_docs/version-3.8/20-usage/72-linter.md diff --git a/docs/versioned_docs/version-3.5/20-usage/75-project-settings.md b/docs/versioned_docs/version-3.8/20-usage/75-project-settings.md similarity index 100% rename from docs/versioned_docs/version-3.5/20-usage/75-project-settings.md rename to docs/versioned_docs/version-3.8/20-usage/75-project-settings.md diff --git a/docs/versioned_docs/version-3.5/20-usage/80-badges.md b/docs/versioned_docs/version-3.8/20-usage/80-badges.md similarity index 100% rename from docs/versioned_docs/version-3.5/20-usage/80-badges.md rename to docs/versioned_docs/version-3.8/20-usage/80-badges.md diff --git a/docs/versioned_docs/version-3.5/20-usage/90-advanced-usage.md b/docs/versioned_docs/version-3.8/20-usage/90-advanced-usage.md similarity index 100% rename from docs/versioned_docs/version-3.5/20-usage/90-advanced-usage.md rename to docs/versioned_docs/version-3.8/20-usage/90-advanced-usage.md diff --git a/docs/versioned_docs/version-3.5/20-usage/_category_.yaml b/docs/versioned_docs/version-3.8/20-usage/_category_.yaml similarity index 100% rename from docs/versioned_docs/version-3.5/20-usage/_category_.yaml rename to docs/versioned_docs/version-3.8/20-usage/_category_.yaml diff --git a/docs/versioned_docs/version-3.5/20-usage/cron-settings.png b/docs/versioned_docs/version-3.8/20-usage/cron-settings.png similarity index 100% rename from docs/versioned_docs/version-3.5/20-usage/cron-settings.png rename to docs/versioned_docs/version-3.8/20-usage/cron-settings.png diff --git a/docs/versioned_docs/version-3.5/20-usage/linter-warnings-errors.png b/docs/versioned_docs/version-3.8/20-usage/linter-warnings-errors.png similarity index 100% rename from docs/versioned_docs/version-3.5/20-usage/linter-warnings-errors.png rename to docs/versioned_docs/version-3.8/20-usage/linter-warnings-errors.png diff --git a/docs/versioned_docs/version-3.5/20-usage/pipeline.png b/docs/versioned_docs/version-3.8/20-usage/pipeline.png similarity index 100% rename from docs/versioned_docs/version-3.5/20-usage/pipeline.png rename to docs/versioned_docs/version-3.8/20-usage/pipeline.png diff --git a/docs/versioned_docs/version-3.5/20-usage/project-settings.png b/docs/versioned_docs/version-3.8/20-usage/project-settings.png similarity index 100% rename from docs/versioned_docs/version-3.5/20-usage/project-settings.png rename to docs/versioned_docs/version-3.8/20-usage/project-settings.png diff --git a/docs/versioned_docs/version-3.5/20-usage/repo-new.png b/docs/versioned_docs/version-3.8/20-usage/repo-new.png similarity index 100% rename from docs/versioned_docs/version-3.5/20-usage/repo-new.png rename to docs/versioned_docs/version-3.8/20-usage/repo-new.png diff --git a/docs/versioned_docs/version-3.5/20-usage/secrets-plugins-filter.png b/docs/versioned_docs/version-3.8/20-usage/secrets-plugins-filter.png similarity index 100% rename from docs/versioned_docs/version-3.5/20-usage/secrets-plugins-filter.png rename to docs/versioned_docs/version-3.8/20-usage/secrets-plugins-filter.png diff --git a/docs/versioned_docs/version-3.5/30-administration/00-general.md b/docs/versioned_docs/version-3.8/30-administration/00-general.md similarity index 100% rename from docs/versioned_docs/version-3.5/30-administration/00-general.md rename to docs/versioned_docs/version-3.8/30-administration/00-general.md diff --git a/docs/versioned_docs/version-3.5/30-administration/05-installation/10-docker-compose.md b/docs/versioned_docs/version-3.8/30-administration/05-installation/10-docker-compose.md similarity index 100% rename from docs/versioned_docs/version-3.5/30-administration/05-installation/10-docker-compose.md rename to docs/versioned_docs/version-3.8/30-administration/05-installation/10-docker-compose.md diff --git a/docs/versioned_docs/version-3.5/30-administration/05-installation/20-helm-chart.md b/docs/versioned_docs/version-3.8/30-administration/05-installation/20-helm-chart.md similarity index 100% rename from docs/versioned_docs/version-3.5/30-administration/05-installation/20-helm-chart.md rename to docs/versioned_docs/version-3.8/30-administration/05-installation/20-helm-chart.md diff --git a/docs/versioned_docs/version-3.5/30-administration/05-installation/30-packages.md b/docs/versioned_docs/version-3.8/30-administration/05-installation/30-packages.md similarity index 98% rename from docs/versioned_docs/version-3.5/30-administration/05-installation/30-packages.md rename to docs/versioned_docs/version-3.8/30-administration/05-installation/30-packages.md index 0ea24b73a..3a28dfa04 100644 --- a/docs/versioned_docs/version-3.5/30-administration/05-installation/30-packages.md +++ b/docs/versioned_docs/version-3.8/30-administration/05-installation/30-packages.md @@ -56,7 +56,7 @@ After installing the agent, copy the example environment file `/etc/woodpecker/w ```ini title="/usr/local/lib/systemd/system/woodpecker-agent.service" [Unit] Description=WoodpeckerCI agent -Documentation=https://woodpecker-ci.org/docs/administration/agent-config +Documentation=https://woodpecker-ci.org/docs/administration/configuration/agent Requires=network.target After=network.target ConditionFileNotEmpty=/etc/woodpecker/woodpecker-agent.env diff --git a/docs/versioned_docs/version-3.5/30-administration/05-installation/_category_.yaml b/docs/versioned_docs/version-3.8/30-administration/05-installation/_category_.yaml similarity index 100% rename from docs/versioned_docs/version-3.5/30-administration/05-installation/_category_.yaml rename to docs/versioned_docs/version-3.8/30-administration/05-installation/_category_.yaml diff --git a/docs/versioned_docs/version-3.5/30-administration/10-configuration/10-server.md b/docs/versioned_docs/version-3.8/30-administration/10-configuration/10-server.md similarity index 100% rename from docs/versioned_docs/version-3.5/30-administration/10-configuration/10-server.md rename to docs/versioned_docs/version-3.8/30-administration/10-configuration/10-server.md diff --git a/docs/versioned_docs/version-3.5/30-administration/10-configuration/11-backends/10-docker.md b/docs/versioned_docs/version-3.8/30-administration/10-configuration/11-backends/10-docker.md similarity index 100% rename from docs/versioned_docs/version-3.5/30-administration/10-configuration/11-backends/10-docker.md rename to docs/versioned_docs/version-3.8/30-administration/10-configuration/11-backends/10-docker.md diff --git a/docs/versioned_docs/version-3.5/30-administration/10-configuration/11-backends/20-kubernetes.md b/docs/versioned_docs/version-3.8/30-administration/10-configuration/11-backends/20-kubernetes.md similarity index 100% rename from docs/versioned_docs/version-3.5/30-administration/10-configuration/11-backends/20-kubernetes.md rename to docs/versioned_docs/version-3.8/30-administration/10-configuration/11-backends/20-kubernetes.md diff --git a/docs/versioned_docs/version-3.5/30-administration/10-configuration/11-backends/30-local.md b/docs/versioned_docs/version-3.8/30-administration/10-configuration/11-backends/30-local.md similarity index 100% rename from docs/versioned_docs/version-3.5/30-administration/10-configuration/11-backends/30-local.md rename to docs/versioned_docs/version-3.8/30-administration/10-configuration/11-backends/30-local.md diff --git a/docs/versioned_docs/version-3.5/30-administration/10-configuration/11-backends/50-custom.md b/docs/versioned_docs/version-3.8/30-administration/10-configuration/11-backends/50-custom.md similarity index 100% rename from docs/versioned_docs/version-3.5/30-administration/10-configuration/11-backends/50-custom.md rename to docs/versioned_docs/version-3.8/30-administration/10-configuration/11-backends/50-custom.md diff --git a/docs/versioned_docs/version-3.5/30-administration/10-configuration/11-backends/_category_.yaml b/docs/versioned_docs/version-3.8/30-administration/10-configuration/11-backends/_category_.yaml similarity index 100% rename from docs/versioned_docs/version-3.5/30-administration/10-configuration/11-backends/_category_.yaml rename to docs/versioned_docs/version-3.8/30-administration/10-configuration/11-backends/_category_.yaml diff --git a/docs/versioned_docs/version-3.5/30-administration/10-configuration/12-forges/100-addon.md b/docs/versioned_docs/version-3.8/30-administration/10-configuration/12-forges/100-addon.md similarity index 100% rename from docs/versioned_docs/version-3.5/30-administration/10-configuration/12-forges/100-addon.md rename to docs/versioned_docs/version-3.8/30-administration/10-configuration/12-forges/100-addon.md diff --git a/docs/versioned_docs/version-3.5/30-administration/10-configuration/12-forges/11-overview.md b/docs/versioned_docs/version-3.8/30-administration/10-configuration/12-forges/11-overview.md similarity index 96% rename from docs/versioned_docs/version-3.5/30-administration/10-configuration/12-forges/11-overview.md rename to docs/versioned_docs/version-3.8/30-administration/10-configuration/12-forges/11-overview.md index 701a7a489..ca1c79b6b 100644 --- a/docs/versioned_docs/version-3.5/30-administration/10-configuration/12-forges/11-overview.md +++ b/docs/versioned_docs/version-3.8/30-administration/10-configuration/12-forges/11-overview.md @@ -10,6 +10,6 @@ | Event: Release | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :x: | :x: | | Event: Deploy¹ | :white_check_mark: | :x: | :x: | :x: | :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: | :x: | +| [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: | ¹ The deployment event can be triggered for all forges from Woodpecker directly. However, only GitHub can trigger them using webhooks. diff --git a/docs/versioned_docs/version-3.5/30-administration/10-configuration/12-forges/20-github.md b/docs/versioned_docs/version-3.8/30-administration/10-configuration/12-forges/20-github.md similarity index 100% rename from docs/versioned_docs/version-3.5/30-administration/10-configuration/12-forges/20-github.md rename to docs/versioned_docs/version-3.8/30-administration/10-configuration/12-forges/20-github.md diff --git a/docs/versioned_docs/version-3.5/30-administration/10-configuration/12-forges/30-gitea.md b/docs/versioned_docs/version-3.8/30-administration/10-configuration/12-forges/30-gitea.md similarity index 100% rename from docs/versioned_docs/version-3.5/30-administration/10-configuration/12-forges/30-gitea.md rename to docs/versioned_docs/version-3.8/30-administration/10-configuration/12-forges/30-gitea.md diff --git a/docs/versioned_docs/version-3.5/30-administration/10-configuration/12-forges/35-forgejo.md b/docs/versioned_docs/version-3.8/30-administration/10-configuration/12-forges/35-forgejo.md similarity index 100% rename from docs/versioned_docs/version-3.5/30-administration/10-configuration/12-forges/35-forgejo.md rename to docs/versioned_docs/version-3.8/30-administration/10-configuration/12-forges/35-forgejo.md diff --git a/docs/versioned_docs/version-3.5/30-administration/10-configuration/12-forges/40-gitlab.md b/docs/versioned_docs/version-3.8/30-administration/10-configuration/12-forges/40-gitlab.md similarity index 100% rename from docs/versioned_docs/version-3.5/30-administration/10-configuration/12-forges/40-gitlab.md rename to docs/versioned_docs/version-3.8/30-administration/10-configuration/12-forges/40-gitlab.md diff --git a/docs/versioned_docs/version-3.5/30-administration/10-configuration/12-forges/50-bitbucket.md b/docs/versioned_docs/version-3.8/30-administration/10-configuration/12-forges/50-bitbucket.md similarity index 100% rename from docs/versioned_docs/version-3.5/30-administration/10-configuration/12-forges/50-bitbucket.md rename to docs/versioned_docs/version-3.8/30-administration/10-configuration/12-forges/50-bitbucket.md diff --git a/docs/versioned_docs/version-3.5/30-administration/10-configuration/12-forges/60-bitbucket_datacenter.md b/docs/versioned_docs/version-3.8/30-administration/10-configuration/12-forges/60-bitbucket_datacenter.md similarity index 100% rename from docs/versioned_docs/version-3.5/30-administration/10-configuration/12-forges/60-bitbucket_datacenter.md rename to docs/versioned_docs/version-3.8/30-administration/10-configuration/12-forges/60-bitbucket_datacenter.md diff --git a/docs/versioned_docs/version-3.5/30-administration/10-configuration/12-forges/_category_.yaml b/docs/versioned_docs/version-3.8/30-administration/10-configuration/12-forges/_category_.yaml similarity index 100% rename from docs/versioned_docs/version-3.5/30-administration/10-configuration/12-forges/_category_.yaml rename to docs/versioned_docs/version-3.8/30-administration/10-configuration/12-forges/_category_.yaml diff --git a/docs/versioned_docs/version-3.5/30-administration/10-configuration/12-forges/bitbucket_oauth.png b/docs/versioned_docs/version-3.8/30-administration/10-configuration/12-forges/bitbucket_oauth.png similarity index 100% rename from docs/versioned_docs/version-3.5/30-administration/10-configuration/12-forges/bitbucket_oauth.png rename to docs/versioned_docs/version-3.8/30-administration/10-configuration/12-forges/bitbucket_oauth.png diff --git a/docs/versioned_docs/version-3.5/30-administration/10-configuration/12-forges/bitbucket_permissions.png b/docs/versioned_docs/version-3.8/30-administration/10-configuration/12-forges/bitbucket_permissions.png similarity index 100% rename from docs/versioned_docs/version-3.5/30-administration/10-configuration/12-forges/bitbucket_permissions.png rename to docs/versioned_docs/version-3.8/30-administration/10-configuration/12-forges/bitbucket_permissions.png diff --git a/docs/versioned_docs/version-3.5/30-administration/10-configuration/12-forges/gitea_oauth.gif b/docs/versioned_docs/version-3.8/30-administration/10-configuration/12-forges/gitea_oauth.gif similarity index 100% rename from docs/versioned_docs/version-3.5/30-administration/10-configuration/12-forges/gitea_oauth.gif rename to docs/versioned_docs/version-3.8/30-administration/10-configuration/12-forges/gitea_oauth.gif diff --git a/docs/versioned_docs/version-3.5/30-administration/10-configuration/12-forges/github_oauth.png b/docs/versioned_docs/version-3.8/30-administration/10-configuration/12-forges/github_oauth.png similarity index 100% rename from docs/versioned_docs/version-3.5/30-administration/10-configuration/12-forges/github_oauth.png rename to docs/versioned_docs/version-3.8/30-administration/10-configuration/12-forges/github_oauth.png diff --git a/docs/versioned_docs/version-3.5/30-administration/10-configuration/30-agent.md b/docs/versioned_docs/version-3.8/30-administration/10-configuration/30-agent.md similarity index 100% rename from docs/versioned_docs/version-3.5/30-administration/10-configuration/30-agent.md rename to docs/versioned_docs/version-3.8/30-administration/10-configuration/30-agent.md diff --git a/docs/versioned_docs/version-3.5/30-administration/10-configuration/40-autoscaler.md b/docs/versioned_docs/version-3.8/30-administration/10-configuration/40-autoscaler.md similarity index 100% rename from docs/versioned_docs/version-3.5/30-administration/10-configuration/40-autoscaler.md rename to docs/versioned_docs/version-3.8/30-administration/10-configuration/40-autoscaler.md diff --git a/docs/versioned_docs/version-3.5/30-administration/10-configuration/_category_.yaml b/docs/versioned_docs/version-3.8/30-administration/10-configuration/_category_.yaml similarity index 100% rename from docs/versioned_docs/version-3.5/30-administration/10-configuration/_category_.yaml rename to docs/versioned_docs/version-3.8/30-administration/10-configuration/_category_.yaml diff --git a/docs/versioned_docs/version-3.5/30-administration/10-configuration/new-agent-connected.png b/docs/versioned_docs/version-3.8/30-administration/10-configuration/new-agent-connected.png similarity index 100% rename from docs/versioned_docs/version-3.5/30-administration/10-configuration/new-agent-connected.png rename to docs/versioned_docs/version-3.8/30-administration/10-configuration/new-agent-connected.png diff --git a/docs/versioned_docs/version-3.5/30-administration/10-configuration/new-agent-created.png b/docs/versioned_docs/version-3.8/30-administration/10-configuration/new-agent-created.png similarity index 100% rename from docs/versioned_docs/version-3.5/30-administration/10-configuration/new-agent-created.png rename to docs/versioned_docs/version-3.8/30-administration/10-configuration/new-agent-created.png diff --git a/docs/versioned_docs/version-3.5/30-administration/10-configuration/new-agent-registration.png b/docs/versioned_docs/version-3.8/30-administration/10-configuration/new-agent-registration.png similarity index 100% rename from docs/versioned_docs/version-3.5/30-administration/10-configuration/new-agent-registration.png rename to docs/versioned_docs/version-3.8/30-administration/10-configuration/new-agent-registration.png diff --git a/docs/versioned_docs/version-3.5/30-administration/_category_.yaml b/docs/versioned_docs/version-3.8/30-administration/_category_.yaml similarity index 100% rename from docs/versioned_docs/version-3.5/30-administration/_category_.yaml rename to docs/versioned_docs/version-3.8/30-administration/_category_.yaml diff --git a/docs/versioned_docs/version-3.5/40-cli.md b/docs/versioned_docs/version-3.8/40-cli.md similarity index 73% rename from docs/versioned_docs/version-3.5/40-cli.md rename to docs/versioned_docs/version-3.8/40-cli.md index 428b8a119..739e21a4d 100644 --- a/docs/versioned_docs/version-3.5/40-cli.md +++ b/docs/versioned_docs/version-3.8/40-cli.md @@ -16,6 +16,9 @@ woodpecker-cli [--nocolor] [--pretty] [--server|-s]=[value] +[--skip-verify] +[--socks-proxy-off] +[--socks-proxy]=[value] [--token|-t]=[value] ``` @@ -45,14 +48,23 @@ woodpecker-cli [GLOBAL OPTIONS] [command [COMMAND OPTIONS]] [ARGUMENTS...] **--server, -s**="": server address -**--token, -t**="": server auth token +**--skip-verify**: skip ssl verification +**--socks-proxy**="": socks proxy address + +**--socks-proxy-off**: socks proxy ignored + +**--token, -t**="": server auth token # COMMANDS ## admin -administer server settings +manage server settings + +### log-level + +retrieve log level from server, or set it with [level] ### registry @@ -60,7 +72,7 @@ manage global registries #### add -adds a registry +add a registry **--hostname**="": registry hostname (default: docker.io) @@ -74,6 +86,26 @@ remove a registry **--hostname**="": registry hostname (default: docker.io) +#### ls + +list registries + +**--format**="": format output (deprecated) (default: {{ .Address }}  +Username: {{ .Username }} +Email: {{ .Email }} +) + +#### show + +show registry information + +**--format**="": format output (deprecated) (default: {{ .Address }}  +Username: {{ .Username }} +Email: {{ .Email }} +) + +**--hostname**="": registry hostname (default: docker.io) + #### update update a registry @@ -86,324 +118,92 @@ update a registry **--username**="": registry username -#### info +### secret -display registry info - -**--hostname**="": registry hostname (default: docker.io) - -#### ls - -list registries - -## org - -manage organizations - -### registry - -manage organization registries +manage global secrets #### add -adds a registry +add a secret -**--hostname**="": registry hostname (default: docker.io) +**--event**="": secret limited to these events (default: []) -**--organization, --org**="": organization id or full name (e.g. 123 or octocat) +**--image**="": secret limited to these images (default: []) -**--password**="": registry password +**--name**="": secret name -**--username**="": registry username +**--value**="": secret value #### rm -remove a registry +remove a secret -**--hostname**="": registry hostname (default: docker.io) - -**--organization, --org**="": organization id or full name (e.g. 123 or octocat) - -#### update - -update a registry - -**--hostname**="": registry hostname (default: docker.io) - -**--organization, --org**="": organization id or full name (e.g. 123 or octocat) - -**--password**="": registry password - -**--username**="": registry username - -#### info - -display registry info - -**--hostname**="": registry hostname (default: docker.io) - -**--organization, --org**="": organization id or full name (e.g. 123 or octocat) +**--name**="": secret name #### ls -list registries +list secrets -**--organization, --org**="": organization id or full name (e.g. 123 or octocat) - -## repo - -manage repositories - -### ls - -list all repos - -**--all**: query all repos, including inactive ones - -**--format**="": format output (default: {{ .FullName }} (id: {{ .ID }}, forgeRemoteID: {{ .ForgeRemoteID }}, isActive: {{ .IsActive }})) - -**--org**="": filter by organization - -### info - -show repository details - -**--format**="": format output (default: Owner: {{ .Owner }} -Repo: {{ .Name }} -URL: {{ .ForgeURL }} -Config path: {{ .Config }} -Visibility: {{ .Visibility }} -Private: {{ .IsSCMPrivate }} -Trusted: {{ .IsTrusted }} -Gated: {{ .IsGated }} -Require approval for: {{ .RequireApproval }} -Clone url: {{ .Clone }} -Allow pull-requests: {{ .AllowPullRequests }} +**--format**="": format output (deprecated) (default: {{ .Name }}  +Events: {{ list .Events }} +{{- if .Images }} +Images: {{ list .Images }} +{{- else }} +Images: +{{- end }} ) -### add +#### show -add a repository +show secret information -### update +**--format**="": format output (deprecated) (default: {{ .Name }}  +Events: {{ list .Events }} +{{- if .Images }} +Images: {{ list .Images }} +{{- else }} +Images: +{{- end }} +) -update a repository +**--name**="": secret name -**--config**="": repository configuration path (e.g. .woodpecker.yml) +#### update -**--gated**: repository is gated +update a secret -**--pipeline-counter**="": repository starting pipeline number (default: 0) +**--event**="": secret limited to these events (default: []) -**--require-approval**="": repository requires approval for +**--image**="": secret limited to these images (default: []) -**--timeout**="": repository timeout (default: 0s) +**--name**="": secret name -**--trusted**: repository is trusted +**--value**="": secret value -**--unsafe**: validate updating the pipeline-counter is unsafe +### user -**--visibility**="": repository visibility - -### rm - -remove a repository - -### repair - -repair repository webhooks - -### chown - -assume ownership of a repository - -### sync - -synchronize the repository list - -**--format**="": format output (default: {{ .FullName }} (id: {{ .ID }}, forgeRemoteID: {{ .ForgeRemoteID }}, isActive: {{ .IsActive }})) - -### registry - -manage registries +manage users #### add -adds a registry - -**--hostname**="": registry hostname (default: docker.io) - -**--password**="": registry password - -**--repository, --repo**="": repository id or full name (e.g. 134 or octocat/hello-world) - -**--username**="": registry username - -#### rm - -remove a registry - -**--hostname**="": registry hostname (default: docker.io) - -**--repository, --repo**="": repository id or full name (e.g. 134 or octocat/hello-world) - -#### update - -update a registry - -**--hostname**="": registry hostname (default: docker.io) - -**--password**="": registry password - -**--repository, --repo**="": repository id or full name (e.g. 134 or octocat/hello-world) - -**--username**="": registry username - -#### info - -display registry info - -**--hostname**="": registry hostname (default: docker.io) - -**--repository, --repo**="": repository id or full name (e.g. 134 or octocat/hello-world) +add a user #### ls -list registries +list all users -**--repository, --repo**="": repository id or full name (e.g. 134 or octocat/hello-world) +**--format**="": format output (default: {{ .Login }}) -## pipeline +#### rm -manage pipelines +remove a user -### ls +#### show -show pipeline history +show user information -**--after**="": only return pipelines after this RFC3339 date (default: 0001-01-01 00:00:00 +0000 UTC) - -**--before**="": only return pipelines before this RFC3339 date (default: 0001-01-01 00:00:00 +0000 UTC) - -**--branch**="": branch filter - -**--event**="": event filter - -**--limit**="": limit the list size (default: 25) - -**--output**="": output format (default: table) - -**--output-no-headers**: don't print headers - -**--status**="": status filter - -### last - -show latest pipeline details - -**--branch**="": branch name (default: main) - -**--output**="": output format (default: table) - -**--output-no-headers**: don't print headers - -### logs - -show pipeline logs - -### info - -show pipeline details - -**--output**="": output format (default: table) - -**--output-no-headers**: don't print headers - -### stop - -stop a pipeline - -### start - -start a pipeline - -**--param, -p**="": custom parameters to be injected into the step environment. Format: KEY=value (default: []) - -### approve - -approve a pipeline - -### decline - -decline a pipeline - -### queue - -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 }} -) - -### ps - -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 }} -) - -### create - -create new pipeline - -**--branch**="": branch to create pipeline from - -**--output**="": output format (default: table) - -**--output-no-headers**: don't print headers - -**--var**="": key=value (default: []) - -## log - -manage logs - -### purge - -purge a log - -## deploy - -trigger a pipeline with the 'deployment' event - -**--branch**="": branch filter - -**--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 }} -) - -**--param, -p**="": custom parameters to be injected into the step environment. Format: KEY=value (default: []) - -**--status**="": status filter (default: success) +**--format**="": format output (default: User: {{ .Login }} +Email: {{ .Email }}) ## exec @@ -465,12 +265,10 @@ execute a local pipeline **--backend-k8s-volume-size**="": backend k8s volume size (default 10G) (default: 10G) -**--backend-local-temp-dir**="": set a different temp dir to clone workflows into (default: /var/folders/6m/t779gl5s7fq17_t_59fflg5w0000gn/T/) +**--backend-local-temp-dir**="": set a different temp dir to clone workflows into (default: /tmp) **--backend-no-proxy**="": if set, pass the environment variable down as "NO_PROXY" to steps -**--commit-author-avatar**="": Set the metadata environment variable "CI_COMMIT_AUTHOR_AVATAR". - **--commit-author-email**="": Set the metadata environment variable "CI_COMMIT_AUTHOR_EMAIL". **--commit-author-name**="": Set the metadata environment variable "CI_COMMIT_AUTHOR". @@ -527,8 +325,6 @@ execute a local pipeline **--plugins-privileged**="": Allow plugins to run in privileged mode, if environment variable is defined but empty there will be none (default: []) -**--prev-commit-author-avatar**="": Set the metadata environment variable "CI_PREV_COMMIT_AUTHOR_AVATAR". - **--prev-commit-author-email**="": Set the metadata environment variable "CI_PREV_COMMIT_AUTHOR_EMAIL". **--prev-commit-author-name**="": Set the metadata environment variable "CI_PREV_COMMIT_AUTHOR". @@ -575,8 +371,6 @@ execute a local pipeline **--repo-remote-id**="": Set the metadata environment variable "CI_REPO_REMOTE_ID". -**--repo-scm**="": Set the metadata environment variable "CI_REPO_SCM". (default: git) - **--repo-trusted-network**: Set the metadata environment variable "CI_REPO_TRUSTED_NETWORK". **--repo-trusted-security**: Set the metadata environment variable "CI_REPO_TRUSTED_SECURITY". @@ -601,144 +395,341 @@ execute a local pipeline **--workflow-number**="": Set the metadata environment variable "CI_WORKFLOW_NUMBER". (default: 0) -**--workspace-base**="": (default: /woodpecker) +**--workspace-base**="": (default: /woodpecker) -**--workspace-path**="": (default: src) +**--workspace-path**="": (default: src) ## info show information about the current user -## secret - -manage secrets - -### add - -adds a secret - -**--event**="": secret limited to these events (default: []) - -**--global**: global secret - -**--image**="": secret limited to these images (default: []) - -**--name**="": secret name - -**--organization, --org**="": organization id or full name (e.g. 123 or octocat) - -**--repository, --repo**="": repository id or full name (e.g. 134 or octocat/hello-world) - -**--value**="": secret value - -### rm - -remove a secret - -**--global**: global secret - -**--name**="": secret name - -**--organization, --org**="": organization id or full name (e.g. 123 or octocat) - -**--repository, --repo**="": repository id or full name (e.g. 134 or octocat/hello-world) - -### update - -update a secret - -**--event**="": secret limited to these events (default: []) - -**--global**: global secret - -**--image**="": secret limited to these images (default: []) - -**--name**="": secret name - -**--organization, --org**="": organization id or full name (e.g. 123 or octocat) - -**--repository, --repo**="": repository id or full name (e.g. 134 or octocat/hello-world) - -**--value**="": secret value - -### info - -display secret info - -**--global**: global secret - -**--name**="": secret name - -**--organization, --org**="": organization id or full name (e.g. 123 or octocat) - -**--repository, --repo**="": repository id or full name (e.g. 134 or octocat/hello-world) - -### ls - -list secrets - -**--global**: global secret - -**--organization, --org**="": organization id or full name (e.g. 123 or octocat) - -**--repository, --repo**="": repository id or full name (e.g. 134 or octocat/hello-world) - -## user - -manage users - -### ls - -list all users - -**--format**="": format output (default: {{ .Login }}) - -### info - -show user details - -**--format**="": format output (default: User: {{ .Login }} +**--format**="": format output (deprecated) (default: User: {{ .Login }} Email: {{ .Email }}) -### add - -adds a user - -### rm - -remove a user - ## lint lint a pipeline configuration file -**--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 set empty, there is no (default: []) -**--plugins-trusted-clone**="": Plugins which are trusted to handle Git credentials in clone steps (default: [docker.io/woodpeckerci/plugin-git:2.6.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.6.3 docker.io/woodpeckerci/plugin-git quay.io/woodpeckerci/plugin-git]) **--strict**: treat warnings as errors -## log-level +## org -get the logging level of the server, or set it with [level] +manage organizations -## cron +### registry + +manage organization registries + +#### add + +add a registry + +**--hostname**="": registry hostname (default: docker.io) + +**--organization, --org**="": organization id or full name (e.g. 123 or octocat) + +**--password**="": registry password + +**--username**="": registry username + +#### rm + +remove a registry + +**--hostname**="": registry hostname (default: docker.io) + +**--organization, --org**="": organization id or full name (e.g. 123 or octocat) + +#### ls + +list registries + +**--format**="": format output (deprecated) (default: {{ .Address }}  +Username: {{ .Username }} +Email: {{ .Email }} +) + +**--organization, --org**="": organization id or full name (e.g. 123 or octocat) + +#### show + +show registry information + +**--format**="": format output (deprecated) (default: {{ .Address }}  +Username: {{ .Username }} +Email: {{ .Email }} +) + +**--hostname**="": registry hostname (default: docker.io) + +**--organization, --org**="": organization id or full name (e.g. 123 or octocat) + +#### update + +update a registry + +**--hostname**="": registry hostname (default: docker.io) + +**--organization, --org**="": organization id or full name (e.g. 123 or octocat) + +**--password**="": registry password + +**--username**="": registry username + +### secret + +manage secrets + +#### add + +add a secret + +**--event**="": secret limited to these events (default: []) + +**--image**="": secret limited to these images (default: []) + +**--name**="": secret name + +**--organization, --org**="": organization id or full name (e.g. 123 or octocat) + +**--value**="": secret value + +#### rm + +remove a secret + +**--name**="": secret name + +**--organization, --org**="": organization id or full name (e.g. 123 or octocat) + +#### ls + +list secrets + +**--format**="": format output (deprecated) (default: {{ .Name }}  +Events: {{ list .Events }} +{{- if .Images }} +Images: {{ list .Images }} +{{- else }} +Images: +{{- end }} +) + +**--organization, --org**="": organization id or full name (e.g. 123 or octocat) + +#### show + +show secret information + +**--format**="": format output (deprecated) (default: {{ .Name }}  +Events: {{ list .Events }} +{{- if .Images }} +Images: {{ list .Images }} +{{- else }} +Images: +{{- end }} +) + +**--name**="": secret name + +**--organization, --org**="": organization id or full name (e.g. 123 or octocat) + +#### update + +update a secret + +**--event**="": limit secret to these event (default: []) + +**--image**="": limit secret to these image (default: []) + +**--name**="": secret name + +**--organization, --org**="": organization id or full name (e.g. 123 or octocat) + +**--value**="": secret value + +## pipeline + +manage pipelines + +### approve + +approve a pipeline + +### create + +create new pipeline + +**--branch**="": branch to create pipeline from + +**--output**="": output format (default: table) + +**--output-no-headers**: don't print headers + +**--var**="": key=value (default: []) + +### decline + +decline a pipeline + +### deploy + +trigger a pipeline with the 'deployment' event + +**--branch**="": branch filter + +**--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 }} +) + +**--param, -p**="": custom parameters to inject into the step environment. Format: KEY=value (default: []) + +**--status**="": status filter (default: success) + +### last + +show latest pipeline information + +**--branch**="": branch name (default: main) + +**--output**="": output format (default: table) + +**--output-no-headers**: don't print headers + +### ls + +show pipeline history + +**--after**="": only return pipelines after this date (RFC3339) (default: 0001-01-01 00:00:00 +0000 UTC) + +**--before**="": only return pipelines before this date (RFC3339) (default: 0001-01-01 00:00:00 +0000 UTC) + +**--branch**="": branch filter + +**--event**="": event filter + +**--limit**="": limit the list size (default: 25) + +**--output**="": output format (default: table) + +**--output-no-headers**: don't print headers + +**--status**="": status filter + +### log + +manage logs + +#### purge + +purge a log + +#### show + +show pipeline logs + +### ps + +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 }} +) + +### purge + +purge pipelines + +**--dry-run**: disable non-read api calls + +**--keep-min**="": minimum number of pipelines to keep (default: 10) + +**--older-than**="": remove pipelines older than the specified time limit + +### queue + +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 }} +) + +### show + +show pipeline information + +**--output**="": output format (default: table) + +**--output-no-headers**: don't print headers + +### start + +start a pipeline + +**--param, -p**="": custom parameters to inject into the step environment. Format: KEY=value (default: []) + +### stop + +stop a pipeline + +## repo + +manage repositories + +### add + +add a repository + +### chown + +assume ownership of a repository + +### cron manage cron jobs -### add +#### add add a cron job **--branch**="": cron branch +**--format**="": format output (deprecated) (default: {{ .Name }}  +ID: {{ .ID }} +Branch: {{ .Branch }} +Schedule: {{ .Schedule }} +NextExec: {{ .NextExec }} +) + **--name**="": cron name **--repository, --repo**="": repository id or full name (e.g. 134 or octocat/hello-world) **--schedule**="": cron schedule -### rm +#### rm remove a cron job @@ -746,12 +737,47 @@ remove a cron job **--repository, --repo**="": repository id or full name (e.g. 134 or octocat/hello-world) -### update +#### ls + +list cron jobs + +**--format**="": format output (deprecated) (default: {{ .Name }}  +ID: {{ .ID }} +Branch: {{ .Branch }} +Schedule: {{ .Schedule }} +NextExec: {{ .NextExec }} +) + +**--repository, --repo**="": repository id or full name (e.g. 134 or octocat/hello-world) + +#### show + +show cron job information + +**--format**="": format output (deprecated) (default: {{ .Name }}  +ID: {{ .ID }} +Branch: {{ .Branch }} +Schedule: {{ .Schedule }} +NextExec: {{ .NextExec }} +) + +**--id**="": cron id + +**--repository, --repo**="": repository id or full name (e.g. 134 or octocat/hello-world) + +#### update update a cron job **--branch**="": cron branch +**--format**="": format output (deprecated) (default: {{ .Name }}  +ID: {{ .ID }} +Branch: {{ .Branch }} +Schedule: {{ .Schedule }} +NextExec: {{ .NextExec }} +) + **--id**="": cron id **--name**="": cron name @@ -760,27 +786,199 @@ update a cron job **--schedule**="": cron schedule -### info - -display info about a cron job - -**--id**="": cron id - -**--repository, --repo**="": repository id or full name (e.g. 134 or octocat/hello-world) - ### ls -list cron jobs +list all repos + +**--all**: query all repos, including inactive ones + +**--format**="": format output (deprecated) + +**--org**="": filter by organization + +**--output**="": output format (default: table) + +**--output-no-headers**: don't print headers + +### registry + +manage registries + +#### add + +add a registry + +**--hostname**="": registry hostname (default: docker.io) + +**--password**="": registry password **--repository, --repo**="": repository id or full name (e.g. 134 or octocat/hello-world) +**--username**="": registry username + +#### rm + +remove a registry + +**--hostname**="": registry hostname (default: docker.io) + +**--repository, --repo**="": repository id or full name (e.g. 134 or octocat/hello-world) + +#### ls + +list registries + +**--format**="": format output (deprecated) (default: {{ .Address }}  +Username: {{ .Username }} +Email: {{ .Email }} +) + +**--repository, --repo**="": repository id or full name (e.g. 134 or octocat/hello-world) + +#### show + +show registry information + +**--format**="": format output (deprecated) (default: {{ .Address }}  +Username: {{ .Username }} +Email: {{ .Email }} +) + +**--hostname**="": registry hostname (default: docker.io) + +**--repository, --repo**="": repository id or full name (e.g. 134 or octocat/hello-world) + +#### update + +update a registry + +**--hostname**="": registry hostname (default: docker.io) + +**--password**="": registry password + +**--repository, --repo**="": repository id or full name (e.g. 134 or octocat/hello-world) + +**--username**="": registry username + +### rm + +remove a repository + +### repair + +repair repository webhooks + +### secret + +manage secrets + +#### add + +add a secret + +**--event**="": limit secret to these events (default: []) + +**--image**="": limit secret to these images (default: []) + +**--name**="": secret name + +**--repository, --repo**="": repository id or full name (e.g. 134 or octocat/hello-world) + +**--value**="": secret value + +#### rm + +remove a secret + +**--name**="": secret name + +**--repository, --repo**="": repository id or full name (e.g. 134 or octocat/hello-world) + +#### ls + +list secrets + +**--format**="": format output (deprecated) (default: {{ .Name }}  +Events: {{ list .Events }} +{{- if .Images }} +Images: {{ list .Images }} +{{- else }} +Images: +{{- end }} +) + +**--repository, --repo**="": repository id or full name (e.g. 134 or octocat/hello-world) + +#### show + +show secret information + +**--format**="": format output (deprecated) (default: {{ .Name }}  +Events: {{ list .Events }} +{{- if .Images }} +Images: {{ list .Images }} +{{- else }} +Images: +{{- end }} +) + +**--name**="": secret name + +**--repository, --repo**="": repository id or full name (e.g. 134 or octocat/hello-world) + +#### update + +update a secret + +**--event**="": limit secret to these events (default: []) + +**--image**="": limit secret to these images (default: []) + +**--name**="": secret name + +**--repository, --repo**="": repository id or full name (e.g. 134 or octocat/hello-world) + +**--value**="": secret value + +### show + +show repository information + +**--output**="": output format (default: table) + +**--output-no-headers**: don't print headers + +### sync + +synchronize the repository list + +**--format**="": format output (default: {{ .FullName }} (id: {{ .ID }}, forgeRemoteID: {{ .ForgeRemoteID }}, isActive: {{ .IsActive }})) + +### update + +update a repository + +**--config**="": repository configuration path. Example: .woodpecker.yml + +**--pipeline-counter**="": repository starting pipeline number (default: 0) + +**--require-approval**="": repository requires approval for + +**--timeout**="": repository timeout (default: 0s) + +**--trusted**: repository is trusted + +**--unsafe**: allow unsafe operations + +**--visibility**="": repository visibility + ## setup setup the woodpecker-cli for the first time -**--server**="": The URL of the woodpecker server +**--server**="": URL of the woodpecker server -**--token**="": The token to authenticate with the woodpecker server +**--token**="": token to authenticate with the woodpecker server ## update diff --git a/docs/versioned_docs/version-3.5/92-development/01-getting-started.md b/docs/versioned_docs/version-3.8/92-development/01-getting-started.md similarity index 100% rename from docs/versioned_docs/version-3.5/92-development/01-getting-started.md rename to docs/versioned_docs/version-3.8/92-development/01-getting-started.md diff --git a/docs/versioned_docs/version-3.5/92-development/02-core-ideas.md b/docs/versioned_docs/version-3.8/92-development/02-core-ideas.md similarity index 100% rename from docs/versioned_docs/version-3.5/92-development/02-core-ideas.md rename to docs/versioned_docs/version-3.8/92-development/02-core-ideas.md diff --git a/docs/versioned_docs/version-3.5/92-development/03-ui.md b/docs/versioned_docs/version-3.8/92-development/03-ui.md similarity index 100% rename from docs/versioned_docs/version-3.5/92-development/03-ui.md rename to docs/versioned_docs/version-3.8/92-development/03-ui.md diff --git a/docs/versioned_docs/version-3.5/92-development/04-docs.md b/docs/versioned_docs/version-3.8/92-development/04-docs.md similarity index 100% rename from docs/versioned_docs/version-3.5/92-development/04-docs.md rename to docs/versioned_docs/version-3.8/92-development/04-docs.md diff --git a/docs/versioned_docs/version-3.5/92-development/05-architecture.md b/docs/versioned_docs/version-3.8/92-development/05-architecture.md similarity index 100% rename from docs/versioned_docs/version-3.5/92-development/05-architecture.md rename to docs/versioned_docs/version-3.8/92-development/05-architecture.md diff --git a/docs/versioned_docs/version-3.5/92-development/06-conventions.md b/docs/versioned_docs/version-3.8/92-development/06-conventions.md similarity index 100% rename from docs/versioned_docs/version-3.5/92-development/06-conventions.md rename to docs/versioned_docs/version-3.8/92-development/06-conventions.md diff --git a/docs/versioned_docs/version-3.5/92-development/07-guides.md b/docs/versioned_docs/version-3.8/92-development/07-guides.md similarity index 100% rename from docs/versioned_docs/version-3.5/92-development/07-guides.md rename to docs/versioned_docs/version-3.8/92-development/07-guides.md diff --git a/docs/versioned_docs/version-3.5/92-development/08-translations.md b/docs/versioned_docs/version-3.8/92-development/08-translations.md similarity index 100% rename from docs/versioned_docs/version-3.5/92-development/08-translations.md rename to docs/versioned_docs/version-3.8/92-development/08-translations.md diff --git a/docs/versioned_docs/version-3.5/92-development/09-openapi.md b/docs/versioned_docs/version-3.8/92-development/09-openapi.md similarity index 100% rename from docs/versioned_docs/version-3.5/92-development/09-openapi.md rename to docs/versioned_docs/version-3.8/92-development/09-openapi.md diff --git a/docs/versioned_docs/version-3.5/92-development/09-testing.md b/docs/versioned_docs/version-3.8/92-development/09-testing.md similarity index 100% rename from docs/versioned_docs/version-3.5/92-development/09-testing.md rename to docs/versioned_docs/version-3.8/92-development/09-testing.md diff --git a/docs/versioned_docs/version-3.5/92-development/_category_.yaml b/docs/versioned_docs/version-3.8/92-development/_category_.yaml similarity index 100% rename from docs/versioned_docs/version-3.5/92-development/_category_.yaml rename to docs/versioned_docs/version-3.8/92-development/_category_.yaml diff --git a/docs/versioned_docs/version-3.5/92-development/ui-proxy.svg b/docs/versioned_docs/version-3.8/92-development/ui-proxy.svg similarity index 100% rename from docs/versioned_docs/version-3.5/92-development/ui-proxy.svg rename to docs/versioned_docs/version-3.8/92-development/ui-proxy.svg diff --git a/docs/versioned_docs/version-3.5/92-development/vscode-debug.png b/docs/versioned_docs/version-3.8/92-development/vscode-debug.png similarity index 100% rename from docs/versioned_docs/version-3.5/92-development/vscode-debug.png rename to docs/versioned_docs/version-3.8/92-development/vscode-debug.png diff --git a/docs/versioned_docs/version-3.5/92-development/vscode-run-test.png b/docs/versioned_docs/version-3.8/92-development/vscode-run-test.png similarity index 100% rename from docs/versioned_docs/version-3.5/92-development/vscode-run-test.png rename to docs/versioned_docs/version-3.8/92-development/vscode-run-test.png diff --git a/docs/versioned_docs/version-3.5/92-development/woodpecker-architecture.png b/docs/versioned_docs/version-3.8/92-development/woodpecker-architecture.png similarity index 100% rename from docs/versioned_docs/version-3.5/92-development/woodpecker-architecture.png rename to docs/versioned_docs/version-3.8/92-development/woodpecker-architecture.png diff --git a/docs/versioned_sidebars/version-3.5-sidebars.json b/docs/versioned_sidebars/version-3.8-sidebars.json similarity index 100% rename from docs/versioned_sidebars/version-3.5-sidebars.json rename to docs/versioned_sidebars/version-3.8-sidebars.json diff --git a/docs/versions.json b/docs/versions.json index 1a0871888..63e062510 100644 --- a/docs/versions.json +++ b/docs/versions.json @@ -1,6 +1,6 @@ [ + "3.8", "3.7", "3.6", - "3.5", "2.8" ]