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
33 lines
973 B
TypeScript
33 lines
973 B
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 {readFileSync} from 'fs';
|
|
import {resolve} from 'path';
|
|
import {parse as parseYaml} from 'yaml';
|
|
|
|
import {error, green, info, red} from '../utils/console';
|
|
import {GitClient} from '../utils/git/git-client';
|
|
|
|
export function verify() {
|
|
const git = GitClient.get();
|
|
/** Full path to NgBot config file */
|
|
const NGBOT_CONFIG_YAML_PATH = resolve(git.baseDir, '.github/angular-robot.yml');
|
|
|
|
/** The NgBot config file */
|
|
const ngBotYaml = readFileSync(NGBOT_CONFIG_YAML_PATH, 'utf8');
|
|
|
|
try {
|
|
// Try parsing the config file to verify that the syntax is correct.
|
|
parseYaml(ngBotYaml);
|
|
info(`${green('√')} Valid NgBot YAML config`);
|
|
} catch (e) {
|
|
error(`${red('!')} Invalid NgBot YAML config`);
|
|
error(e);
|
|
process.exitCode = 1;
|
|
}
|
|
}
|