From f2c12e0eaf9a7cb7eb423e85147e6bf1bc978175 Mon Sep 17 00:00:00 2001 From: Robert Kaussow Date: Wed, 23 Apr 2025 10:07:53 +0200 Subject: [PATCH] Use slugified plugin urls in docs (#5116) --- docs/blog/2024-01-01-continuous-deployment/index.md | 4 ++-- docs/docs/20-usage/51-plugins/20-creating-plugins.md | 2 +- docs/docs/20-usage/75-project-settings.md | 2 +- docs/docs/20-usage/90-advanced-usage.md | 2 +- docs/plugins/woodpecker-plugins/src/index.ts | 9 ++++++++- .../20-usage/51-plugins/20-creating-plugins.md | 2 +- .../version-2.8/20-usage/90-advanced-usage.md | 2 +- .../20-usage/51-plugins/20-creating-plugins.md | 2 +- .../version-3.3/20-usage/75-project-settings.md | 2 +- .../version-3.3/20-usage/90-advanced-usage.md | 2 +- .../20-usage/51-plugins/20-creating-plugins.md | 2 +- .../version-3.4/20-usage/75-project-settings.md | 2 +- .../version-3.4/20-usage/90-advanced-usage.md | 2 +- .../20-usage/51-plugins/20-creating-plugins.md | 2 +- .../version-3.5/20-usage/75-project-settings.md | 2 +- .../version-3.5/20-usage/90-advanced-usage.md | 2 +- pipeline/frontend/yaml/linter/schema/schema.json | 2 +- 17 files changed, 25 insertions(+), 18 deletions(-) diff --git a/docs/blog/2024-01-01-continuous-deployment/index.md b/docs/blog/2024-01-01-continuous-deployment/index.md index f455186a6..6f05f570f 100644 --- a/docs/blog/2024-01-01-continuous-deployment/index.md +++ b/docs/blog/2024-01-01-continuous-deployment/index.md @@ -24,7 +24,7 @@ The final step in your pipeline could SSH into the app server and run a deployme One of the benefits would be that the deployment script's output could be included in the pipeline's log. However in general, this is a complicated option as it tightly couples the CI and app servers. -An SSH step could be written by using a plugin, like [ssh](https://plugins.drone.io/plugins/ssh) or [git push](https://woodpecker-ci.org/plugins/Git%20Push). +An SSH step could be written by using a plugin, like [ssh](https://plugins.drone.io/plugins/ssh) or [git push](https://woodpecker-ci.org/plugins/git-push). ## Polling for asset changes @@ -38,7 +38,7 @@ This option is easy to maintain, but the downside is a short delay (one minute) If you are using a configuration management tool (e.g. Ansible, Chef, Puppet), then you could setup the last pipeline step to call that tool to perform the redeployment. -A plugin for [Ansible](https://woodpecker-ci.org/plugins/Ansible) exists and could be adapted accordingly. +A plugin for [Ansible](https://woodpecker-ci.org/plugins/ansible) exists and could be adapted accordingly. This option is complex and only suitable in an environment in which you're already using configuration management. diff --git a/docs/docs/20-usage/51-plugins/20-creating-plugins.md b/docs/docs/20-usage/51-plugins/20-creating-plugins.md index 4591a1d1a..dbecbf8c1 100644 --- a/docs/docs/20-usage/51-plugins/20-creating-plugins.md +++ b/docs/docs/20-usage/51-plugins/20-creating-plugins.md @@ -136,4 +136,4 @@ docker run --rm \ - Use [built-in env vars](../50-environment.md#built-in-environment-variables) where possible. - Do not use any configuration except settings (and internal env vars). This means: Don't require using [`environment`](../50-environment.md) and don't require specific secret names. - Add a `docs.md` file, listing all your settings and plugin metadata ([example](https://github.com/woodpecker-ci/plugin-git/blob/main/docs.md)). -- Add your plugin to the [plugin index](/plugins) using your `docs.md` ([the example above in the index](https://woodpecker-ci.org/plugins/Git%20Clone)). +- Add your plugin to the [plugin index](/plugins) using your `docs.md` ([the example above in the index](https://woodpecker-ci.org/plugins/git-clone)). diff --git a/docs/docs/20-usage/75-project-settings.md b/docs/docs/20-usage/75-project-settings.md index d4495c41b..170997b30 100644 --- a/docs/docs/20-usage/75-project-settings.md +++ b/docs/docs/20-usage/75-project-settings.md @@ -52,7 +52,7 @@ Without an explicit allowlist, a malicious contributor could exploit a custom cl :::info This setting does not affect subsequent steps, nor does it allow direct pushes to the repository. -To enable pushing changes, you can inject Git credentials as a secret or use a dedicated plugin, such as [appleboy/drone-git-push](https://woodpecker-ci.org/plugins/Git%20Push). +To enable pushing changes, you can inject Git credentials as a secret or use a dedicated plugin, such as [appleboy/drone-git-push](https://woodpecker-ci.org/plugins/git-push). ::: ## Project visibility diff --git a/docs/docs/20-usage/90-advanced-usage.md b/docs/docs/20-usage/90-advanced-usage.md index e8a691de0..4b700fc0c 100644 --- a/docs/docs/20-usage/90-advanced-usage.md +++ b/docs/docs/20-usage/90-advanced-usage.md @@ -138,7 +138,7 @@ See [project settings](./75-project-settings.md#trusted) to enable "trusted" mod The snippet below shows how a step can communicate with the docker daemon running in a `docker:dind` service. :::note -If your goal is to build/publish OCI images, consider using the [Docker Buildx Plugin](https://woodpecker-ci.org/plugins/Docker%20Buildx) instead. +If your goal is to build/publish OCI images, consider using the [Docker Buildx Plugin](https://woodpecker-ci.org/plugins/docker-buildx) instead. ::: First we need to define a service running a docker with the `dind` tag. diff --git a/docs/plugins/woodpecker-plugins/src/index.ts b/docs/plugins/woodpecker-plugins/src/index.ts index 8c8958500..84ee4cf56 100644 --- a/docs/plugins/woodpecker-plugins/src/index.ts +++ b/docs/plugins/woodpecker-plugins/src/index.ts @@ -21,7 +21,14 @@ async function loadContent(): Promise { const response = await axios(i.docs); docsContent = response.data; } catch (e) { - console.error("Can't fetch docs file", i.docs, (e as AxiosError).message); + const axiosError = e as AxiosError; + console.error( + "Can't fetch docs file", + i.docs, + axiosError.message, + axiosError.response?.status, + axiosError.response?.statusText + ); return undefined; } diff --git a/docs/versioned_docs/version-2.8/20-usage/51-plugins/20-creating-plugins.md b/docs/versioned_docs/version-2.8/20-usage/51-plugins/20-creating-plugins.md index 8a0ea5920..4685c72df 100644 --- a/docs/versioned_docs/version-2.8/20-usage/51-plugins/20-creating-plugins.md +++ b/docs/versioned_docs/version-2.8/20-usage/51-plugins/20-creating-plugins.md @@ -136,4 +136,4 @@ docker run --rm \ - Use [built-in env vars](../50-environment.md#built-in-environment-variables) where possible. - Do not use any configuration except settings (and internal env vars). This means: Don't require using [`environment`](../50-environment.md) and don't require specific secret names. - Add a `docs.md` file, listing all your settings and plugin metadata ([example](https://github.com/woodpecker-ci/plugin-git/blob/main/docs.md)). -- Add your plugin to the [plugin index](/plugins) using your `docs.md` ([the example above in the index](https://woodpecker-ci.org/plugins/Git%20Clone)). +- Add your plugin to the [plugin index](/plugins) using your `docs.md` ([the example above in the index](https://woodpecker-ci.org/plugins/git-clone)). diff --git a/docs/versioned_docs/version-2.8/20-usage/90-advanced-usage.md b/docs/versioned_docs/version-2.8/20-usage/90-advanced-usage.md index 2cfb1b7a4..fecfeff73 100644 --- a/docs/versioned_docs/version-2.8/20-usage/90-advanced-usage.md +++ b/docs/versioned_docs/version-2.8/20-usage/90-advanced-usage.md @@ -138,7 +138,7 @@ See [project settings](./75-project-settings.md#trusted) to enable trusted mode. The snippet below shows how a step can communicate with the docker daemon via a `docker:dind` service. :::note -If your aim ist to build/publish OCI images, consider using the [Docker Buildx Plugin](https://woodpecker-ci.org/plugins/Docker%20Buildx) instead. +If your aim ist to build/publish OCI images, consider using the [Docker Buildx Plugin](https://woodpecker-ci.org/plugins/docker-buildx) instead. ::: First we need to define a servie running a docker with the `dind` tag. This service must run in privileged mode: diff --git a/docs/versioned_docs/version-3.3/20-usage/51-plugins/20-creating-plugins.md b/docs/versioned_docs/version-3.3/20-usage/51-plugins/20-creating-plugins.md index 4591a1d1a..dbecbf8c1 100644 --- a/docs/versioned_docs/version-3.3/20-usage/51-plugins/20-creating-plugins.md +++ b/docs/versioned_docs/version-3.3/20-usage/51-plugins/20-creating-plugins.md @@ -136,4 +136,4 @@ docker run --rm \ - Use [built-in env vars](../50-environment.md#built-in-environment-variables) where possible. - Do not use any configuration except settings (and internal env vars). This means: Don't require using [`environment`](../50-environment.md) and don't require specific secret names. - Add a `docs.md` file, listing all your settings and plugin metadata ([example](https://github.com/woodpecker-ci/plugin-git/blob/main/docs.md)). -- Add your plugin to the [plugin index](/plugins) using your `docs.md` ([the example above in the index](https://woodpecker-ci.org/plugins/Git%20Clone)). +- Add your plugin to the [plugin index](/plugins) using your `docs.md` ([the example above in the index](https://woodpecker-ci.org/plugins/git-clone)). diff --git a/docs/versioned_docs/version-3.3/20-usage/75-project-settings.md b/docs/versioned_docs/version-3.3/20-usage/75-project-settings.md index d4495c41b..170997b30 100644 --- a/docs/versioned_docs/version-3.3/20-usage/75-project-settings.md +++ b/docs/versioned_docs/version-3.3/20-usage/75-project-settings.md @@ -52,7 +52,7 @@ Without an explicit allowlist, a malicious contributor could exploit a custom cl :::info This setting does not affect subsequent steps, nor does it allow direct pushes to the repository. -To enable pushing changes, you can inject Git credentials as a secret or use a dedicated plugin, such as [appleboy/drone-git-push](https://woodpecker-ci.org/plugins/Git%20Push). +To enable pushing changes, you can inject Git credentials as a secret or use a dedicated plugin, such as [appleboy/drone-git-push](https://woodpecker-ci.org/plugins/git-push). ::: ## Project visibility diff --git a/docs/versioned_docs/version-3.3/20-usage/90-advanced-usage.md b/docs/versioned_docs/version-3.3/20-usage/90-advanced-usage.md index e8a691de0..4b700fc0c 100644 --- a/docs/versioned_docs/version-3.3/20-usage/90-advanced-usage.md +++ b/docs/versioned_docs/version-3.3/20-usage/90-advanced-usage.md @@ -138,7 +138,7 @@ See [project settings](./75-project-settings.md#trusted) to enable "trusted" mod The snippet below shows how a step can communicate with the docker daemon running in a `docker:dind` service. :::note -If your goal is to build/publish OCI images, consider using the [Docker Buildx Plugin](https://woodpecker-ci.org/plugins/Docker%20Buildx) instead. +If your goal is to build/publish OCI images, consider using the [Docker Buildx Plugin](https://woodpecker-ci.org/plugins/docker-buildx) instead. ::: First we need to define a service running a docker with the `dind` tag. diff --git a/docs/versioned_docs/version-3.4/20-usage/51-plugins/20-creating-plugins.md b/docs/versioned_docs/version-3.4/20-usage/51-plugins/20-creating-plugins.md index 4591a1d1a..dbecbf8c1 100644 --- a/docs/versioned_docs/version-3.4/20-usage/51-plugins/20-creating-plugins.md +++ b/docs/versioned_docs/version-3.4/20-usage/51-plugins/20-creating-plugins.md @@ -136,4 +136,4 @@ docker run --rm \ - Use [built-in env vars](../50-environment.md#built-in-environment-variables) where possible. - Do not use any configuration except settings (and internal env vars). This means: Don't require using [`environment`](../50-environment.md) and don't require specific secret names. - Add a `docs.md` file, listing all your settings and plugin metadata ([example](https://github.com/woodpecker-ci/plugin-git/blob/main/docs.md)). -- Add your plugin to the [plugin index](/plugins) using your `docs.md` ([the example above in the index](https://woodpecker-ci.org/plugins/Git%20Clone)). +- Add your plugin to the [plugin index](/plugins) using your `docs.md` ([the example above in the index](https://woodpecker-ci.org/plugins/git-clone)). diff --git a/docs/versioned_docs/version-3.4/20-usage/75-project-settings.md b/docs/versioned_docs/version-3.4/20-usage/75-project-settings.md index d4495c41b..170997b30 100644 --- a/docs/versioned_docs/version-3.4/20-usage/75-project-settings.md +++ b/docs/versioned_docs/version-3.4/20-usage/75-project-settings.md @@ -52,7 +52,7 @@ Without an explicit allowlist, a malicious contributor could exploit a custom cl :::info This setting does not affect subsequent steps, nor does it allow direct pushes to the repository. -To enable pushing changes, you can inject Git credentials as a secret or use a dedicated plugin, such as [appleboy/drone-git-push](https://woodpecker-ci.org/plugins/Git%20Push). +To enable pushing changes, you can inject Git credentials as a secret or use a dedicated plugin, such as [appleboy/drone-git-push](https://woodpecker-ci.org/plugins/git-push). ::: ## Project visibility diff --git a/docs/versioned_docs/version-3.4/20-usage/90-advanced-usage.md b/docs/versioned_docs/version-3.4/20-usage/90-advanced-usage.md index e8a691de0..4b700fc0c 100644 --- a/docs/versioned_docs/version-3.4/20-usage/90-advanced-usage.md +++ b/docs/versioned_docs/version-3.4/20-usage/90-advanced-usage.md @@ -138,7 +138,7 @@ See [project settings](./75-project-settings.md#trusted) to enable "trusted" mod The snippet below shows how a step can communicate with the docker daemon running in a `docker:dind` service. :::note -If your goal is to build/publish OCI images, consider using the [Docker Buildx Plugin](https://woodpecker-ci.org/plugins/Docker%20Buildx) instead. +If your goal is to build/publish OCI images, consider using the [Docker Buildx Plugin](https://woodpecker-ci.org/plugins/docker-buildx) instead. ::: First we need to define a service running a docker with the `dind` tag. diff --git a/docs/versioned_docs/version-3.5/20-usage/51-plugins/20-creating-plugins.md b/docs/versioned_docs/version-3.5/20-usage/51-plugins/20-creating-plugins.md index 4591a1d1a..dbecbf8c1 100644 --- a/docs/versioned_docs/version-3.5/20-usage/51-plugins/20-creating-plugins.md +++ b/docs/versioned_docs/version-3.5/20-usage/51-plugins/20-creating-plugins.md @@ -136,4 +136,4 @@ docker run --rm \ - Use [built-in env vars](../50-environment.md#built-in-environment-variables) where possible. - Do not use any configuration except settings (and internal env vars). This means: Don't require using [`environment`](../50-environment.md) and don't require specific secret names. - Add a `docs.md` file, listing all your settings and plugin metadata ([example](https://github.com/woodpecker-ci/plugin-git/blob/main/docs.md)). -- Add your plugin to the [plugin index](/plugins) using your `docs.md` ([the example above in the index](https://woodpecker-ci.org/plugins/Git%20Clone)). +- Add your plugin to the [plugin index](/plugins) using your `docs.md` ([the example above in the index](https://woodpecker-ci.org/plugins/git-clone)). diff --git a/docs/versioned_docs/version-3.5/20-usage/75-project-settings.md b/docs/versioned_docs/version-3.5/20-usage/75-project-settings.md index d4495c41b..170997b30 100644 --- a/docs/versioned_docs/version-3.5/20-usage/75-project-settings.md +++ b/docs/versioned_docs/version-3.5/20-usage/75-project-settings.md @@ -52,7 +52,7 @@ Without an explicit allowlist, a malicious contributor could exploit a custom cl :::info This setting does not affect subsequent steps, nor does it allow direct pushes to the repository. -To enable pushing changes, you can inject Git credentials as a secret or use a dedicated plugin, such as [appleboy/drone-git-push](https://woodpecker-ci.org/plugins/Git%20Push). +To enable pushing changes, you can inject Git credentials as a secret or use a dedicated plugin, such as [appleboy/drone-git-push](https://woodpecker-ci.org/plugins/git-push). ::: ## Project visibility diff --git a/docs/versioned_docs/version-3.5/20-usage/90-advanced-usage.md b/docs/versioned_docs/version-3.5/20-usage/90-advanced-usage.md index e8a691de0..4b700fc0c 100644 --- a/docs/versioned_docs/version-3.5/20-usage/90-advanced-usage.md +++ b/docs/versioned_docs/version-3.5/20-usage/90-advanced-usage.md @@ -138,7 +138,7 @@ See [project settings](./75-project-settings.md#trusted) to enable "trusted" mod The snippet below shows how a step can communicate with the docker daemon running in a `docker:dind` service. :::note -If your goal is to build/publish OCI images, consider using the [Docker Buildx Plugin](https://woodpecker-ci.org/plugins/Docker%20Buildx) instead. +If your goal is to build/publish OCI images, consider using the [Docker Buildx Plugin](https://woodpecker-ci.org/plugins/docker-buildx) instead. ::: First we need to define a service running a docker with the `dind` tag. diff --git a/pipeline/frontend/yaml/linter/schema/schema.json b/pipeline/frontend/yaml/linter/schema/schema.json index 2c992e6dc..e1fd411f6 100644 --- a/pipeline/frontend/yaml/linter/schema/schema.json +++ b/pipeline/frontend/yaml/linter/schema/schema.json @@ -98,7 +98,7 @@ ] }, "clone_settings": { - "description": "Change the settings of your clone plugin. Read more: https://woodpecker-ci.org/plugins/Git%20Clone", + "description": "Change the settings of your clone plugin. Read more: https://woodpecker-ci.org/plugins/git-clone", "type": "object", "properties": { "depth": {