mirrors/woodpecker
1
0
Fork 0
mirror of https://github.com/woodpecker-ci/woodpecker.git synced 2024-12-23 17:00:30 +00:00
Code Issues Projects Releases Wiki Activity

Update/fix some docs (#3359)

Browse source
This commit is contained in:
qwerty287 2024-02-09 11:20:12 +01:00 committed by GitHub
parent 134fb7900c
commit 7def93e783
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 10 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/docs/20-usage/40-secrets.md
View file

@ -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. 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. 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 ```diff
steps: 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. 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 ## Image filter

2
docs/docs/30-administration/22-backends/20-local.md
View file

@ -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 anyone can submit code or add new repositories. You shouldn't execute the agent
as a privileged user (root). 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. code and execute commands.
In order to use this backend, you need to download (or build) the In order to use this backend, you need to download (or build) the

4
docs/docs/92-development/10-custom-agent-backends.md → docs/docs/30-administration/22-backends/50-custom-backends.md
View file

@ -1,4 +1,4 @@
# Custom agent backends # Custom backends
If none of our backends fits your usecases, you can write your own. If none of our backends fits your usecases, you can write your own.
@ -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.

2
docs/docs/30-administration/60-ssl.md
View file

@ -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: Update your configuration to provide the paths of your certificate and key:
```yaml title="docker-compose.yaml" ```diff title="docker-compose.yaml"
version: '3' version: '3'
services: services: