Clarify how GITHUB_USER should be setup in the development guide.#947
Clarify how GITHUB_USER should be setup in the development guide.#947istio-merge-robot merged 1 commit intoistio:masterfrom baodongli:issue/918
Conversation
|
Hi @baodongli. Thanks for your PR. I'm waiting for a istio member to verify that this patch is reasonable to test. If it is, they should reply with I understand the commands that are listed here. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here. |
| export GITHUB_USER=$USER # replace with actual if different | ||
| # If your github username is not the same as your local user name (saved in the | ||
| # shell variable $USER), then replace "$USER" below with your github username | ||
| export GITHUB_USER=$USER |
There was a problem hiding this comment.
I think the original document is clear enough as it already claiming update the "$GITHUB_USER" below with your github username
There was a problem hiding this comment.
Not sure I totally agree. line 91 in the original text indicates replacing $GITHUB_USER (which = $USER) although it is possible someone might read that as "Replace "GITHUB_USER" below with your github username.
As an example, lets say the machine login is stdake and the github login is sdake, I could see people doing something like this:
export sdake=$USER
There was a problem hiding this comment.
A different way to fix this would be have the text read
replace "$USER" below with your github id
|
/release-note-none |
sdake
left a comment
There was a problem hiding this comment.
I think this could be a little confusing to some newcomers. Perhaps there is something simpler (as specified in the review) that could be used.
| export GITHUB_USER=$USER # replace with actual if different | ||
| # If your github username is not the same as your local user name (saved in the | ||
| # shell variable $USER), then replace "$USER" below with your github username | ||
| export GITHUB_USER=$USER |
There was a problem hiding this comment.
A different way to fix this would be have the text read
replace "$USER" below with your github id
|
it's not dramatically better but I don't think it's worse so let's just get this in |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: ldemailly The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these OWNERS Files:
You can indicate your approval by writing |
|
/ok-to-test |
|
/test all [submit-queue is verifying that this PR is safe to merge] |
|
Automatic merge from submit-queue |
Automatic merge from submit-queue Clarify how GITHUB_USER should be setup in the development guide. Fixes (#918) This is a follow up change to PR #919: Clarify environment variables set in .profile Prior to this small change, the .profile settings were not completely obvious. Now all profile settings that Istio should expect to use are set in one place **Release Note** NONE **Release note**: ```release-note NONE ``` Former-commit-id: 8bb136a
…tio#947) Automatic merge from submit-queue Clarify how GITHUB_USER should be setup in the development guide. Fixes (istio#918) This is a follow up change to PR istio#919: Clarify environment variables set in .profile Prior to this small change, the .profile settings were not completely obvious. Now all profile settings that Istio should expect to use are set in one place **Release Note** NONE **Release note**: ```release-note NONE ``` Former-commit-id: 8bb136a
Automatic merge from submit-queue Clarify how GITHUB_USER should be setup in the development guide. Fixes (#918) This is a follow up change to PR #919: Clarify environment variables set in .profile Prior to this small change, the .profile settings were not completely obvious. Now all profile settings that Istio should expect to use are set in one place **Release Note** NONE **Release note**: ```release-note NONE ``` Former-commit-id: 8bb136a
Automatic merge from submit-queue. Bring back accidentally deleted build options in istio#736 **What this PR does / why we need it**: istio#736 accidentally remove `-c opt` from release build and a couple of compile options, bring them back. cc @costinm @ldemailly **Special notes for your reviewer**: **Release note**: ```release-note None ```
* minor doc fix Signed-off-by: Rama Chavali <rama.rao@salesforce.com> * generated docs Signed-off-by: Rama Chavali <rama.rao@salesforce.com>
Fixes (#918)
This is a follow up change to PR #919: Clarify environment variables set in
.profile
Prior to this small change, the .profile settings were not completely obvious.
Now all profile settings that Istio should expect to use are set in one place
Release Note
NONE
Release note: