From 3c5a5921e56a69d712fe86905291d13069b419b1 Mon Sep 17 00:00:00 2001 From: qwerty287 <80460567+qwerty287@users.noreply.github.com> Date: Fri, 9 Feb 2024 11:04:57 +0100 Subject: [PATCH 1/6] fix lang --- docs/docs/30-administration/60-ssl.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/30-administration/60-ssl.md b/docs/docs/30-administration/60-ssl.md index 74de210230..755ba205d8 100644 --- a/docs/docs/30-administration/60-ssl.md +++ b/docs/docs/30-administration/60-ssl.md @@ -78,7 +78,7 @@ Update your configuration to mount your certificate and key: Update your configuration to provide the paths of your certificate and key: -```yaml title="docker-compose.yaml" +```diff title="docker-compose.yaml" version: '3' services: From b5f32502a0ccabcc9cd8f8c0ca824b3e1a4b83c0 Mon Sep 17 00:00:00 2001 From: qwerty287 <80460567+qwerty287@users.noreply.github.com> Date: Fri, 9 Feb 2024 11:06:01 +0100 Subject: [PATCH 2/6] Update 20-local.md --- docs/docs/30-administration/22-backends/20-local.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/30-administration/22-backends/20-local.md b/docs/docs/30-administration/22-backends/20-local.md index 4dca5d34ed..7ec95f0f86 100644 --- a/docs/docs/30-administration/22-backends/20-local.md +++ b/docs/docs/30-administration/22-backends/20-local.md @@ -22,7 +22,7 @@ pipeline can be trusted. You shouldn't use it for a public facing CI where anyone can submit code or add new repositories. You shouldn't execute the agent as a privileged user (root). -The local backend will use a random directory in $TMPDIR to store the cloned +The local backend will use a random directory in `$TMPDIR` to store the cloned code and execute commands. In order to use this backend, you need to download (or build) the From 544dec9294394e746c6e0e353ed410596ec15575 Mon Sep 17 00:00:00 2001 From: qwerty287 <80460567+qwerty287@users.noreply.github.com> Date: Fri, 9 Feb 2024 11:07:05 +0100 Subject: [PATCH 3/6] Update and rename docs/docs/92-development/10-custom-agent-backends.md to docs/docs/30-administration/22-backends/50-custom-backends.md --- .../22-backends/50-custom-backends.md} | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename docs/docs/{92-development/10-custom-agent-backends.md => 30-administration/22-backends/50-custom-backends.md} (96%) diff --git a/docs/docs/92-development/10-custom-agent-backends.md b/docs/docs/30-administration/22-backends/50-custom-backends.md similarity index 96% rename from docs/docs/92-development/10-custom-agent-backends.md rename to docs/docs/30-administration/22-backends/50-custom-backends.md index 3514e73d9e..a820863099 100644 --- a/docs/docs/92-development/10-custom-agent-backends.md +++ b/docs/docs/30-administration/22-backends/50-custom-backends.md @@ -1,4 +1,4 @@ -# Custom agent backends +# Custom backends If none of our backends fits your usecases, you can write your own. From bf71f1c600ffa29507f67525677b8379f29f5198 Mon Sep 17 00:00:00 2001 From: qwerty287 <80460567+qwerty287@users.noreply.github.com> Date: Fri, 9 Feb 2024 11:08:02 +0100 Subject: [PATCH 4/6] Update 40-secrets.md --- docs/docs/20-usage/40-secrets.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/docs/20-usage/40-secrets.md b/docs/docs/20-usage/40-secrets.md index 09fc00c45b..db7a9e7f59 100644 --- a/docs/docs/20-usage/40-secrets.md +++ b/docs/docs/20-usage/40-secrets.md @@ -11,7 +11,7 @@ Woodpecker provides three different levels to add secrets to your pipeline. The ## Usage -### Use secrets in commands +### Use secretsagent in commands Secrets are exposed to your pipeline steps and plugins as uppercase environment variables and can therefore be referenced in the commands section of your pipeline, once their usage is declared in the `secrets` section: @@ -31,7 +31,9 @@ once their usage is declared in the `secrets` section: Alternatively, you can get a `setting` from secrets using the `from_secret` syntax. In this example, the secret named `secret_token` would be passed to the setting named `token`, which will be available in the plugin as environment variable named `PLUGIN_TOKEN`. See [Plugins](./51-plugins/20-creating-plugins.md#settings) for details. -**NOTE:** the `from_secret` syntax only works with the newer `settings` block. +:::note +The `from_secret` syntax only works with the newer `settings` block. +::: ```diff steps: @@ -77,7 +79,9 @@ There may be scenarios where you are required to store secrets using alternate n Secrets are not exposed to pull requests by default. You can override this behavior by creating the secret and enabling the `pull_request` event type, either in UI or by CLI, see below. -**NOTE:** Please be careful when exposing secrets to pull requests. If your repository is open source and accepts pull requests your secrets are not safe. A bad actor can submit a malicious pull request that exposes your secrets. +:::note +Please be careful when exposing secrets to pull requests. If your repository is open source and accepts pull requests your secrets are not safe. A bad actor can submit a malicious pull request that exposes your secrets. +::: ## Image filter From af65e73fb77d6c161a41289c339a276d76f74cf2 Mon Sep 17 00:00:00 2001 From: qwerty287 <80460567+qwerty287@users.noreply.github.com> Date: Fri, 9 Feb 2024 11:11:19 +0100 Subject: [PATCH 5/6] Update 40-secrets.md --- docs/docs/20-usage/40-secrets.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/20-usage/40-secrets.md b/docs/docs/20-usage/40-secrets.md index db7a9e7f59..4c814fae51 100644 --- a/docs/docs/20-usage/40-secrets.md +++ b/docs/docs/20-usage/40-secrets.md @@ -11,7 +11,7 @@ Woodpecker provides three different levels to add secrets to your pipeline. The ## Usage -### Use secretsagent in commands +### Use secrets in commands Secrets are exposed to your pipeline steps and plugins as uppercase environment variables and can therefore be referenced in the commands section of your pipeline, once their usage is declared in the `secrets` section: From c245ad5e60dbc04e41ea07fdb35fc310df0edf05 Mon Sep 17 00:00:00 2001 From: qwerty287 <80460567+qwerty287@users.noreply.github.com> Date: Fri, 9 Feb 2024 11:16:46 +0100 Subject: [PATCH 6/6] fix link --- docs/docs/30-administration/22-backends/50-custom-backends.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/30-administration/22-backends/50-custom-backends.md b/docs/docs/30-administration/22-backends/50-custom-backends.md index a820863099..3c771c4ef1 100644 --- a/docs/docs/30-administration/22-backends/50-custom-backends.md +++ b/docs/docs/30-administration/22-backends/50-custom-backends.md @@ -20,4 +20,4 @@ func main() { } ``` -It is also possible to use multiple backends, you can select with [`WOODPECKER_BACKEND`](../30-administration/15-agent-config.md#woodpecker_backend) between them. +It is also possible to use multiple backends, you can select with [`WOODPECKER_BACKEND`](../15-agent-config.md#woodpecker_backend) between them.