Skip to content

Commit a01ca18

Browse files
authored
Merge pull request #10 from buildkite-plugins/chore/versions_and_upgrading
docs: update versions, reduce length of upgrade prose
2 parents b29cebc + fe31dd7 commit a01ca18

File tree

1 file changed

+10
-29
lines changed

1 file changed

+10
-29
lines changed

README.md

Lines changed: 10 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,15 @@
11
# Secrets Buildkite Plugin
22

3-
A Buildkite plugin used to fetch secrets from [Buildkite Secrets](https://buildkite.com/docs/pipelines/security/secrets/buildkite-secrets),
3+
A Buildkite plugin used to fetch secrets from [Buildkite Secrets](https://buildkite.com/docs/pipelines/security/secrets/buildkite-secrets).
44

55
## Changes to consider when upgrading to `v2.0.0`
66

7-
If you're upgrading from `v1.x.x` to `v2.0.0`, please note the potential changes to your workflow:
7+
If upgrading from v1.x.x, note these changes:
88

9-
### Log Format Changes
10-
Log output now uses structured prefixes (`[INFO]`, `[WARNING]`, `[ERROR]`) instead of emoji-based indicators. If you have log parsing scripts or monitoring that relies on specific log formats, you may need to update them.
11-
12-
Before:
13-
```
14-
⚠️ Unable to find secret at my-key
15-
```
16-
17-
After:
18-
```
19-
[ERROR]: Unable to find secret at my-key
20-
```
21-
22-
### Removed Features
23-
- The `dump_env` function has been removed. This debugging feature has been removed for security reasons. If you were using `dump_env: true`, please remove it from your pipeline configuration.
24-
25-
### New Defaults
26-
- Secrets are now automatically redacted from logs by default (requires buildkite-agent v3.67.0+). To opt out, set `skip-redaction: true`.
27-
28-
### Stricter Error Handling
29-
- Malformed or invalid base64-encoded secrets now cause builds to fail immediately, rather than silently continuing. If you have secrets that fail to decode, you will need to fix them before upgrading to v2.0.0. This change helps catch configuration errors early rather than allowing builds to continue with missing secrets.
30-
31-
If these changes are breaking for your use case, we recommend updating your usage to conform with the more secure `v2.0.0`.
9+
- **Log format**: Uses structured prefixes (`[INFO]`, `[WARNING]`, `[ERROR]`) instead of emoji
10+
- **Removed**: `dump_env` function removed for security
11+
- **New default**: Secrets auto-redacted from logs (requires agent v3.67.0+). Opt out with `skip-redaction: true`
12+
- **Stricter errors**: Invalid base64-encoded secrets now fail immediately
3213

3314
## Storing Secrets
3415

@@ -46,7 +27,7 @@ A `pipeline.yml` like this will read each secret out into a ENV variable:
4627
steps:
4728
- command: echo "The content of ANIMAL is \$ANIMAL"
4829
plugins:
49-
- secrets#v1.0.2:
30+
- secrets#v2.0.0:
5031
variables:
5132
ANIMAL: llamas
5233
FOO: bar
@@ -78,7 +59,7 @@ job environment using a pipeline.yml like this:
7859
steps:
7960
- command: build.sh
8061
plugins:
81-
- secrets#v1.0.2:
62+
- secrets#v2.0.0:
8263
env: "llamas"
8364
```
8465
@@ -124,7 +105,7 @@ To disable automatic redaction (not recommended), set `skip-redaction: true`:
124105
steps:
125106
- command: build.sh
126107
plugins:
127-
- secrets#v1.0.2:
108+
- secrets#v2.0.0:
128109
env: "llamas"
129110
skip-redaction: true
130111
```
@@ -141,7 +122,7 @@ By default, the base delay will be 2 seconds, with a maximum of 5 retries.
141122
steps:
142123
- command: build.sh
143124
plugins:
144-
- secrets#v1.0.2:
125+
- secrets#v2.0.0:
145126
env: "llamas"
146127
retry-max-attempts: 10
147128
retry-base-delay: 2

0 commit comments

Comments
 (0)