Update documentation to match the current environment variables - #72
Conversation
|
nit — |
ispasov
left a comment
There was a problem hiding this comment.
LGTM — docs read accurately and match the code (the GITHUB_API_URL deprecation, the "GITHUB_TOKEN is always a github.com token even on GHES" clarification, and the derived-API-URL behavior). Approving; the only thing outstanding is the non-blocking examples/.env nit (a few new keys set to live values rather than commented placeholders) — feel free to fold that in or ignore.
Good points. I have gone ahead and commented out everything that is default with the examples defaulting to the default value as well |
Description
Bring the documentation back in line with the code.
GITHUB_API_URL. That variable is now ignored, and following the old instructions produces a warning on every startupGITHUB_API_URLas deprecated and ignored in the README and the example.env.env:GITHUB_RUNNER_VERSION,MAX_RUNNERS,ORKA_NAMESPACE,RUNNER_DEREGISTRATION_TIMEOUT, andRUNNER_DEREGISTRATION_POLL_INTERVAL, plusENABLE_RECONCILIATIONandVM_TRACKER_INTERVALwhich were only in the example.env, andORKA_VM_USERNAMEandORKA_VM_PASSWORDwhich were only in the READMEGITHUB_TOKENis always a github.com token, even on GHES, that it is used only to look up the latest runner release, and that it is unrelated toGITHUB_PAT. Note the 60 requests per hour unauthenticated limit and the403startup failure that follows from exceeding itGITHUB_RUNNER_VERSIONtakes a bare version with no leadingv, and that setting it removes the startup dependency onapi.github.comentirelyEvery environment variable defined in
pkg/env/constants.gonow appears in both the README and the example.env.