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.

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

A few environment vars are undocumented #19

Closed
gittycat opened this issue Feb 18, 2016 · 3 comments
Closed

A few environment vars are undocumented #19

gittycat opened this issue Feb 18, 2016 · 3 comments

Comments

@gittycat
Copy link

I've noticed that many of the environment variables listed when doing a buildkite-agent start --help are not documented here: https://buildkite.com/docs/guides/environment-variables, although the ones I've tried can be queried in the build step.
A useful one is BUILDKITE_BUILD_PATH

BUILDKITE_AGENT_CONFIG
BUILDKITE_AGENT_DEBUG
BUILDKITE_AGENT_DEBUG_HTTP
BUILDKITE_AGENT_ENDPOINT
BUILDKITE_AGENT_META_DATA
BUILDKITE_AGENT_NO_COLOR
BUILDKITE_AGENT_PRIORITY
BUILDKITE_AGENT_TOKEN
BUILDKITE_BOOTSTRAP_SCRIPT_PATH
BUILDKITE_BUILD_PATH
BUILDKITE_HOOKS_PATH
BUILDKITE_NO_AUTOMATIC_SSH_FINGERPRINT_VERIFICATION
BUILDKITE_NO_COMMAND_EVAL
BUILDKITE_NO_PTY
@toolmantim
Copy link
Contributor

Hey, thanks for the heads up. Some of these are designed to help the agent communicate with the bootstrap.sh script, but we should probably document them in a different section of the doc (as long as they're not internal / expected to change).

@gittycat
Copy link
Author

Yes, you could do a review of what buildkite-agent start --help puts out and decide on what you want to have public. I personally had a need to figure out the relative path from $BUILDKITE_BUILD_PATH where the repo src code is located. I ended up using this

SRC=`pwd | sed 's|'$BUILDKITE_BUILD_PATH'/'$BUILDKITE_AGENT_NAME'/||'`

@harrietgrace harrietgrace added the in progress Issues that have a fix/update in the works label Feb 20, 2019
@harrietgrace
Copy link
Contributor

Hey @gittycat! 👋🏻It took us a while, but we've finally done a big update to the env vars doc 😄There was also a recent agent update that cleaned up a bunch of the vars it was displaying too, so everything should be covered now.

@harrietgrace harrietgrace removed the in progress Issues that have a fix/update in the works label Apr 5, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants