internal: Add comments about env files#3957
Merged
Merged
Conversation
zhming0
approved these changes
May 26, 2026
Contributor
zhming0
left a comment
zhming0
left a comment
There was a problem hiding this comment.
Looks good with a suggestion 👍🏿
| // to the pre-bootstrap hook. | ||
| // - Env files are designed to be validated by the pre-bootstrap hook | ||
| // - Env files are designed to be validated by the pre-bootstrap hook. | ||
| // Because the job env may contain untrusted or even dangerous env vars, |
Contributor
There was a problem hiding this comment.
Should we give an example here?
Contributor
Author
There was a problem hiding this comment.
I've added some more words in parentheses that explain how such an env var might be added, and how it could be dangerous, but I would rather not be overly specific.
DrJosh9000
force-pushed
the
comments-on-env-files
branch
from
8d9cc97 to
214bb7b
Compare
Merged
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
Make it easier to understand what
BUILDKITE_ENV_FILEis for.Context
https://linear.app/buildkite/issue/A-1236
Changes
Add some comments.
Testing
go test ./...). Buildkite employees may check this if the pipeline has run automatically.go tool gofumpt -extra -w .)Disclosures / Credits
These are just some words I wrote