github/woodpecker
1
0
Fork 0
mirror of https://github.com/woodpecker-ci/woodpecker.git synced 2026-04-15 01:41:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Apply suggestions from code review

Browse Source 
Co-authored-by: Patrick Schratz <patrick.schratz@gmail.com>
This commit is contained in:
6543
2024-09-12 21:39:26 +02:00
committed by GitHub
parent 7d8760166f
commit 0108387ea9
2 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/docs/20-usage/40-secrets.md
View File

@@ -28,10 +28,10 @@ once their usage is declared in the `secrets` section:
The case of the environment variables is not changed, but secret matching is done case-insensitively. In the example above, `DOCKER_PASSWORD` would also match if the secret is called `docker_password`.
### Use secrets in normal steps via environment
### Using secrets in non-plugin steps via "environment:"
You can set an environment value from secrets using the `from_secret` syntax.
So the secret key and environment variable name can differ.
This way, the secret key and environment variable name can differ.
```diff
steps:
@@ -45,11 +45,11 @@ So the secret key and environment variable name can differ.
+ from_secret: some_username
```
### Use secrets in plugins via settings
### Using secrets in plugins-steps via "settings:"
The `from_secret` syntax also work for settings in any hierarchy.
In this example, the secret named `secret_token` would be passed to the setting named `SURGE_TOKEN`,which will be available in the plugin as environment variable named `PLUGIN_SURGE_TOKEN` (See [plugins](./51-plugins/20-creating-plugins.md#settings) for details).
In the below example, the secret `SURGE_TOKEN` would be passed to the setting named `surge_token`, which again will be available in the plugin as environment variable named `PLUGIN_SURGE_TOKEN` (See [plugins](./51-plugins/20-creating-plugins.md#settings) for details).
```diff
steps:
@@ -61,7 +61,7 @@ In this example, the secret named `secret_token` would be passed to the setting
+ from_secret: SURGE_TOKEN
```
As settings can have complex structure, the `from_secret` is supported in all of it:
As settings can have complex structures, `from_secret` is supported any:
```yaml
steps:
@@ -71,7 +71,7 @@ steps:
path: 'artifacts'
simple_token:
from_secret: A_TOKEN
advanced:
advanced_setting:
items:
- "value1"
- some:

2
docs/docs/20-usage/51-plugins/20-creating-plugins.md
View File

@@ -42,7 +42,7 @@ Values like this are converted to JSON and then passed to your plugin. In the ex
### Secrets
Secrets should be passed as settings too. Therefore, users should use [`from_secret`](../40-secrets.md#use-secrets-in-plugins-via-settings).
Secrets should be passed as a setting option. Therefore, users should use [`from_secret`](../40-secrets.md#use-secrets-in-plugins-via-settings).
## Plugin library