This file contains 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
This file contains 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
This file contains 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
@@ -311,3 +312,68 @@ export function apiVersionInRange(
}
returnundefined;
}
/**
* Retrieves the github auth token for use with the runner. There are
* three possible locations for the token:
*
* 1. from the cli (considered insecure)
* 2. from stdin
* 3. from the GITHUB_TOKEN environment variable
*
* If both 1 & 2 are specified, then an error is thrown.
* If 1 & 3 or 2 & 3 are specified, then the environment variable is ignored.
*
* @param githubAuth a github app token or PAT
* @param fromStdIn read the github app token or PAT from stdin up to, but excluding the first whitespace
* @param readable the readable stream to use for getting the token (defaults to stdin)
*
* @return a promise resolving to the auth token.
*/
exportasyncfunctiongetGitHubAuth(
logger: Logger,
githubAuth: string|undefined,
fromStdIn: boolean|undefined,
readable=process.stdinasReadable
): Promise<string>{
if(githubAuth&&fromStdIn){
thrownewError(
"Cannot specify both `--github-auth` and `--github-auth-stdin`. Please use `--github-auth-stdin`, which is more secure."
);
}
if(githubAuth){
logger.warning(
"Using `--github-auth` via the CLI is insecure. Use `--github-auth-stdin` instead."
);
returngithubAuth;
}
if(fromStdIn){
returnnewPromise((resolve,reject)=>{
lettoken="";
readable.on("data",(data)=>{
token+=data.toString("utf8");
});
readable.on("end",()=>{
token=token.split(/\s+/)[0].trim();
if(token){
resolve(token);
}else{
reject(newError("Standard input is empty"));
}
});
readable.on("error",(err)=>{
reject(err);
});
});
}
if(process.env.GITHUB_TOKEN){
returnprocess.env.GITHUB_TOKEN;
}
thrownewError(
"No GitHub authentication token was specified. Please provide a token via the GITHUB_TOKEN environment variable, or by adding the `--github-auth-stdin` flag and passing the token via standard input."