67f65a9d25
Currently the `GitClient` accepts a generic parameter for determining
whether the `githubToken` should be set or not. This worked fine so far
in terms of distinguishing between an authenticated and
non-authenticated git client instance, but if we intend to conditionally
show methods only for authenticated instances, the generic parameter
is not suitable.
This commit splits up the `GitClient` into two classes. One for
the base logic without any authorization, and a second class that
extends the base logic with authentication logic. i.e. the
`AuthenticatedGitClient`. This allows us to have specific methods only
for the authenticated instance. e.g.
* `hasOauthScopes` has been moved to only exist for authenticated
instances.
* the GraphQL functionality within `gitClient.github` is not
accessible for non-authenticated instances. GraphQL API requires
authentication as per Github.
The initial motiviation for this was that we want to throw if
`hasOAuthScopes` is called without the Octokit instance having
a token configured. This should help avoiding issues as within
3b434ed94d
that prevented the caretaker process momentarily.
Additionally, the Git client has moved from `index.ts` to
`git-client.ts` for better discoverability in the codebase.
PR Close #42468
60 lines
2.2 KiB
TypeScript
60 lines
2.2 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright Google LLC All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by an MIT-style license that can be
|
|
* found in the LICENSE file at https://angular.io/license
|
|
*/
|
|
|
|
import {getConfig} from '../../utils/config';
|
|
import {error, info, red} from '../../utils/console';
|
|
import {GitClient} from '../../utils/git/git-client';
|
|
import {loadAndValidateConfig, TargetLabel} from '../merge/config';
|
|
import {getBranchesFromTargetLabel, getTargetLabelFromPullRequest, InvalidTargetLabelError} from '../merge/target-label';
|
|
|
|
export async function getTargetBranchesForPr(prNumber: number) {
|
|
/** The ng-dev configuration. */
|
|
const config = getConfig();
|
|
/** Repo owner and name for the github repository. */
|
|
const {owner, name: repo} = config.github;
|
|
/** The singleton instance of the GitClient. */
|
|
const git = GitClient.get();
|
|
/** The validated merge config. */
|
|
const {config: mergeConfig, errors} = await loadAndValidateConfig(config, git.github);
|
|
if (errors !== undefined) {
|
|
throw Error(`Invalid configuration found: ${errors}`);
|
|
}
|
|
/** The current state of the pull request from Github. */
|
|
const prData = (await git.github.pulls.get({owner, repo, pull_number: prNumber})).data;
|
|
/** The list of labels on the PR as strings. */
|
|
const labels = prData.labels.map(l => l.name);
|
|
/** The branch targetted via the Github UI. */
|
|
const githubTargetBranch = prData.base.ref;
|
|
/** The active label which is being used for targetting the PR. */
|
|
let targetLabel: TargetLabel;
|
|
|
|
try {
|
|
targetLabel = getTargetLabelFromPullRequest(mergeConfig!, labels);
|
|
} catch (e) {
|
|
if (e instanceof InvalidTargetLabelError) {
|
|
error(red(e.failureMessage));
|
|
process.exitCode = 1;
|
|
return;
|
|
}
|
|
throw e;
|
|
}
|
|
/** The target branches based on the target label and branch targetted in the Github UI. */
|
|
return await getBranchesFromTargetLabel(targetLabel, githubTargetBranch);
|
|
}
|
|
|
|
|
|
export async function printTargetBranchesForPr(prNumber: number) {
|
|
const targets = await getTargetBranchesForPr(prNumber);
|
|
if (targets === undefined) {
|
|
return;
|
|
}
|
|
info.group(`PR #${prNumber} will merge into:`);
|
|
targets.forEach(target => info(`- ${target}`));
|
|
info.groupEnd();
|
|
}
|