Skip to content

Add config option to fail pipeline upload on parsing warnings as well as errors #3304

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Add config option to fail pipeline upload on parsing warnings as well as errors #3304

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c08097f
Fixes buildkite/agent#3303
nic-littlepay May 7, 2025
bc5199d
Running go fmt
nic-littlepay May 7, 2025
a92cfa4
Merge branch 'main' into fixes-issue-3303
nic-littlepay May 13, 2025
5a47c51
Merge branch 'main' into fixes-issue-3303
nic-littlepay May 14, 2025
28124bc
Merge branch 'main' into fixes-issue-3303
nic-littlepay May 23, 2025
41487a1
Merge branch 'main' into fixes-issue-3303
nic-littlepay May 29, 2025
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
26 changes: 16 additions & 10 deletions clicommand/pipeline_upload.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,14 +72,15 @@ type PipelineUploadConfig struct {
GlobalConfig
APIConfig

FilePath string `cli:"arg:0" label:"upload paths"`
Replace bool `cli:"replace"`
Job string `cli:"job"` // required, but not in dry-run mode
DryRun bool `cli:"dry-run"`
DryRunFormat string `cli:"format"`
NoInterpolation bool `cli:"no-interpolation"`
RedactedVars []string `cli:"redacted-vars" normalize:"list"`
RejectSecrets bool `cli:"reject-secrets"`
FilePath string `cli:"arg:0" label:"upload paths"`
Replace bool `cli:"replace"`
Job string `cli:"job"` // required, but not in dry-run mode
DryRun bool `cli:"dry-run"`
DryRunFormat string `cli:"format"`
NoInterpolation bool `cli:"no-interpolation"`
RedactedVars []string `cli:"redacted-vars" normalize:"list"`
RejectSecrets bool `cli:"reject-secrets"`
FailOnPipelineParseWarning bool `cli:"fail-on-pipeline-parse-warning"`

// Used for signing
JWKSFile string `cli:"jwks-file"`
Expand Down Expand Up @@ -125,9 +126,14 @@ var PipelineUploadCommand = cli.Command{
Usage: "When true, fail the pipeline upload early if the pipeline contains secrets",
EnvVar: "BUILDKITE_AGENT_PIPELINE_UPLOAD_REJECT_SECRETS",
},
cli.BoolFlag{
Name: "fail-on-pipeline-parse-warning",
Usage: "Fail pipeline upload if pipeline parsing returns warnings, as well as errors",
EnvVar: "BUILDKITE_AGENT_FAIL_ON_PIPELINE_PARSE_WARNING",
},

// Note: changes to these environment variables need to be reflected in the environment created
// in the job runner. At the momenet, that's at agent/job_runner.go:500-507
// in the job runner. At the moment, that's at agent/job_runner.go:500-507
cli.StringFlag{
Name: "jwks-file",
Usage: "Path to a file containing a JWKS. Passing this flag enables pipeline signing",
Expand Down Expand Up @@ -249,7 +255,7 @@ var PipelineUploadCommand = cli.Command{
result, err := cfg.parseAndInterpolate(ctx, src, input, environ)
if err != nil {
w := warning.As(err)
if w == nil {
if w == nil || cfg.FailOnPipelineParseWarning {
return err
}
l.Warn("There were some issues with the pipeline input - pipeline upload will proceed, but might not succeed:\n%v", w)
Expand Down