Improve descriptions of some environment variables #4401
Conversation
- Move deprecated and internal variables to the bottom of the list. - Bring `CIRCLECI` to the top of the list. - Make clear that `CIRCLE_INTERNAL_TASK_DATA` is internal. - Improve the accuracy of other descriptions.
|
This is still deprecated, we've got the SHAs in pipeline values in 2.1
config.
|
jekyll/_cci2/env-vars.md
Outdated
| @@ -517,8 +514,11 @@ Variable | Type | Value | |||
| `CIRCLE_USERNAME` | String | The GitHub or Bitbucket username of the user who committed the build. | |||
There was a problem hiding this comment.
Committed the build probably needs changing...
There was a problem hiding this comment.
"whose commit triggered the pipeline" perhaps?
There was a problem hiding this comment.
For webhooks it's the pusher rather than committer, for API calls it's the API caller. So maybe "the user who triggered the pipeline"?
There was a problem hiding this comment.
Yeah that's what I was thinking... hopefully Server people won't be confused by pipeline
There was a problem hiding this comment.
oh, so this isn't the same user that's attributed for credit usage?
There was a problem hiding this comment.
when you say the user who triggered the pipeline, does that’s mean for pipelines triggered by API it will be the user whose token I am using?
also if i do "rerun" or "rerun from failed" on a build started by userA does the CIRCLE_USERNAME change to the person who re-ran?
CIRCLECIto the top of the list.CIRCLE_INTERNAL_TASK_DATAis internal.