Use slugified plugin urls in docs (#5116)

This commit is contained in:
Robert Kaussow 2025-04-23 10:07:53 +02:00 committed by GitHub
parent 208ac771d4
commit f2c12e0eaf
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
17 changed files with 25 additions and 18 deletions

View file

@ -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. 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 ## 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. 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. This option is complex and only suitable in an environment in which you're already using configuration management.

View file

@ -136,4 +136,4 @@ docker run --rm \
- Use [built-in env vars](../50-environment.md#built-in-environment-variables) where possible. - 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. - 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 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)).

View file

@ -52,7 +52,7 @@ Without an explicit allowlist, a malicious contributor could exploit a custom cl
:::info :::info
This setting does not affect subsequent steps, nor does it allow direct pushes to the repository. 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 ## Project visibility

View file

@ -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. The snippet below shows how a step can communicate with the docker daemon running in a `docker:dind` service.
:::note :::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. First we need to define a service running a docker with the `dind` tag.

View file

@ -21,7 +21,14 @@ async function loadContent(): Promise<Content> {
const response = await axios(i.docs); const response = await axios(i.docs);
docsContent = response.data; docsContent = response.data;
} catch (e) { } 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; return undefined;
} }

View file

@ -136,4 +136,4 @@ docker run --rm \
- Use [built-in env vars](../50-environment.md#built-in-environment-variables) where possible. - 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. - 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 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)).

View file

@ -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. The snippet below shows how a step can communicate with the docker daemon via a `docker:dind` service.
:::note :::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: First we need to define a servie running a docker with the `dind` tag. This service must run in privileged mode:

View file

@ -136,4 +136,4 @@ docker run --rm \
- Use [built-in env vars](../50-environment.md#built-in-environment-variables) where possible. - 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. - 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 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)).

View file

@ -52,7 +52,7 @@ Without an explicit allowlist, a malicious contributor could exploit a custom cl
:::info :::info
This setting does not affect subsequent steps, nor does it allow direct pushes to the repository. 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 ## Project visibility

View file

@ -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. The snippet below shows how a step can communicate with the docker daemon running in a `docker:dind` service.
:::note :::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. First we need to define a service running a docker with the `dind` tag.

View file

@ -136,4 +136,4 @@ docker run --rm \
- Use [built-in env vars](../50-environment.md#built-in-environment-variables) where possible. - 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. - 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 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)).

View file

@ -52,7 +52,7 @@ Without an explicit allowlist, a malicious contributor could exploit a custom cl
:::info :::info
This setting does not affect subsequent steps, nor does it allow direct pushes to the repository. 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 ## Project visibility

View file

@ -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. The snippet below shows how a step can communicate with the docker daemon running in a `docker:dind` service.
:::note :::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. First we need to define a service running a docker with the `dind` tag.

View file

@ -136,4 +136,4 @@ docker run --rm \
- Use [built-in env vars](../50-environment.md#built-in-environment-variables) where possible. - 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. - 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 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)).

View file

@ -52,7 +52,7 @@ Without an explicit allowlist, a malicious contributor could exploit a custom cl
:::info :::info
This setting does not affect subsequent steps, nor does it allow direct pushes to the repository. 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 ## Project visibility

View file

@ -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. The snippet below shows how a step can communicate with the docker daemon running in a `docker:dind` service.
:::note :::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. First we need to define a service running a docker with the `dind` tag.

View file

@ -98,7 +98,7 @@
] ]
}, },
"clone_settings": { "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", "type": "object",
"properties": { "properties": {
"depth": { "depth": {