Skip checkout when there are parse errors #275
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
triarius
commented
Mar 14, 2024
| @@ -13,6 +13,5 @@ export IMAGE | |||
|
|
|||
| gotestsum --junitfile "junit-${BUILDKITE_JOB_ID}.xml" -- \ | |||
| -count=1 \ | |||
| -failfast \ | |||
There was a problem hiding this comment.
I think we want to see all the failures at once.
triarius
force-pushed
the
pdp-2023-underlying-parse-error-does-not-print-if-using-gitenvfrom
branch
from
e17ed89 to
44c8310
Compare
Previously, the agent image configured in the controller's config was used for the BuildFailureJob. But customers could have configured this to be a private image. We don't want to copy the imagePullSecrets in as there could be an error in their formatting, and the failure job is designed to bubble up such errors to the job logs. So we use the default agent image which is guaranteed to be public.
triarius
deleted the
pdp-2023-underlying-parse-error-does-not-print-if-using-gitenvfrom
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When the controller attempts to parse the Kubernetes plugin config and encounters an error, it will run a "failure job" that echos the error message as the command so that it is surfaced in the job logs. However, for private repositories that need secrets for checkout, this will fail because the container is not given access to those secrets.
Rather than give the container access to the secrets, in this PR, we skip the checkout step entirely when there are such errors: it is not needed and can only slow down the job or cause some other error.
The error message container is run with the default agent image, which is public, so it should not need any more resources like
imagePullSecretsto run. I guess this means that it won't necessarily work on k8s clusters that are air-gapped, but this image is needed for other containers like theagent startcontainer and theinitcontainer, so no other jobs would work on such clusters anyway.In any case, I don't think transferring things like
gitEnvFromandimagePullSecretare going to work if there was an error in the specification of those fields. We want this failure job to be as bare bones as possible to reduce the chance of errors in the Pipeline YAML from preventing it from running.Fixes: #233, #273
Note to reviews
I've implemented this as a
skipCheckoutflag on theBuildmethod. I'm aware that such practices don't align with our coding standards. But, I think the entireBuildmethod needs to refactored, and I don't want to do that yet. There are a few PRs in flight (#262, #248, #258) that modify theBuildmethod, so a significant refactor would introduce too many merge conflicts.After they are merged, we should refactor this method into smaller, composable pieces so that when there is a parse error, the checkout container is omitted and an error message container is substituted for the job command containers.