Skip to content

Commit dd028d6

Browse files
authored
Update documentation for secret placeholders (#4221)
* Update documentation for secret placeholders fix typo * docgen
1 parent 6853f8b commit dd028d6

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

docs/api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -358,7 +358,7 @@ $path = run('readlink {{deploy_path}}/current');
358358
run("echo $path");
359359
```
360360

361-
Pass secrets via `%name%` placeholders so they are redacted in logs:
361+
Pass secrets via placeholders (e.g. `%token%`) so they are redacted in logs:
362362
```php
363363
run('curl -u admin:%token% https://api.example', secrets: ['token' => getenv('TOKEN')]);
364364
```

src/functions.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -475,7 +475,7 @@ function within(string $path, callable $callback): mixed
475475
* run("echo $path");
476476
* ```
477477
*
478-
* Pass secrets via `%name%` placeholders so they are redacted in logs:
478+
* Pass secrets via placeholders (e.g. `%token%`) so they are redacted in logs:
479479
* ```php
480480
* run('curl -u admin:%token% https://api.example', secrets: ['token' => getenv('TOKEN')]);
481481
* ```

0 commit comments

Comments
 (0)