Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor update to the 'redactor' CLI command examples. #3060

Merged
merged 3 commits into from
Oct 30, 2024
Merged

Minor update to the 'redactor' CLI command examples. #3060

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5f81b79
Remove equal signs from option, to match option table in docs, despit…
gilesgas Oct 30, 2024
724739c
Improve description for '--format value' option for the redactor CLI …
gilesgas Oct 30, 2024
27329ef
Remove unnecessary 'fmt.Sprintf(...)' call.
gilesgas Oct 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions clicommand/redactor_add.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,18 +81,15 @@ To redact multiple secrets from future logs in one command, create a flat
JSON object file (for example, 'my-secrets.json'), with multiple "key" values,
one for each secret:

$ echo '{"key":"secret1","key":"secret2"}' | buildkite-agent redactor add --format=json
$ echo '{"key":"secret1","key":"secret2"}' | buildkite-agent redactor add --format json

Or

$ buildkite-agent redactor add --format=json my-secrets.json`,
$ buildkite-agent redactor add --format json my-secrets.json`,
Flags: []cli.Flag{
cli.StringFlag{
Name: "format",
Usage: fmt.Sprintf(
"The format for the input, one of: %s. ′none′ will add the entire input as a to the redactor, save for leading and trailing whitespace, ′json′ will parse it a string valued JSON Object, where each value of each key will be added to the redactor.",
secretsFormats,
),
Name: "format",
Usage: "The format for the input, whose value is either ′json′ or ′none′. ′none′ adds the entire input's content to the redactor, with the exception of leading and trailing space. ′json′ parses the input's content as a JSON object, where each value of each key is added to the redactor.",
EnvVar: "BUILDKITE_AGENT_REDACT_ADD_FORMAT",
Value: FormatStringNone,
},
Expand Down