feat(dev-infra): add a command to verify NgBot YAML config syntax (#39071)
This commit adds a new command to the `ng-dev` suite, which verifies that the NgBot YAML config is
correct. It also adds this command to the `lint` CircleCI job so that we execute this check while
running CI.
This should help prevent syntax errors similar to the one introduced in:
393ce5574b
PR Close #39071
This commit is contained in:
parent
6205ed0fcc
commit
4bce21358d
|
@ -273,6 +273,7 @@ jobs:
|
|||
- run: yarn -s ng-dev format changed $CI_GIT_BASE_REVISION --check
|
||||
- run: yarn -s ts-circular-deps:check
|
||||
- run: yarn -s ng-dev pullapprove verify
|
||||
- run: yarn -s ng-dev ngbot verify
|
||||
- run: yarn -s ng-dev commit-message validate-range --range $CI_COMMIT_RANGE
|
||||
|
||||
test:
|
||||
|
|
|
@ -11,6 +11,7 @@ ts_library(
|
|||
"//dev-infra/caretaker",
|
||||
"//dev-infra/commit-message",
|
||||
"//dev-infra/format",
|
||||
"//dev-infra/ngbot",
|
||||
"//dev-infra/pr",
|
||||
"//dev-infra/pullapprove",
|
||||
"//dev-infra/release",
|
||||
|
|
|
@ -15,6 +15,7 @@ import {buildReleaseParser} from './release/cli';
|
|||
import {buildPrParser} from './pr/cli';
|
||||
import {captureLogOutputForCommand} from './utils/console';
|
||||
import {buildCaretakerParser} from './caretaker/cli';
|
||||
import {buildNgbotParser} from './ngbot/cli';
|
||||
|
||||
yargs.scriptName('ng-dev')
|
||||
.middleware(captureLogOutputForCommand)
|
||||
|
@ -27,6 +28,7 @@ yargs.scriptName('ng-dev')
|
|||
.command('release <command>', '', buildReleaseParser)
|
||||
.command('ts-circular-deps <command>', '', tsCircularDependenciesBuilder)
|
||||
.command('caretaker <command>', '', buildCaretakerParser)
|
||||
.command('ngbot <command>', false, buildNgbotParser)
|
||||
.wrap(120)
|
||||
.strict()
|
||||
.parse();
|
||||
|
|
|
@ -0,0 +1,19 @@
|
|||
load("@npm_bazel_typescript//:index.bzl", "ts_library")
|
||||
|
||||
ts_library(
|
||||
name = "ngbot",
|
||||
srcs = [
|
||||
"cli.ts",
|
||||
"verify.ts",
|
||||
],
|
||||
module_name = "@angular/dev-infra-private/ngbot",
|
||||
visibility = ["//dev-infra:__subpackages__"],
|
||||
deps = [
|
||||
"//dev-infra/utils",
|
||||
"@npm//@types/node",
|
||||
"@npm//@types/yaml",
|
||||
"@npm//@types/yargs",
|
||||
"@npm//yaml",
|
||||
"@npm//yargs",
|
||||
],
|
||||
)
|
|
@ -0,0 +1,19 @@
|
|||
/**
|
||||
* @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 * as yargs from 'yargs';
|
||||
import {verify} from './verify';
|
||||
|
||||
/** Build the parser for the NgBot commands. */
|
||||
export function buildNgbotParser(localYargs: yargs.Argv) {
|
||||
return localYargs.help().strict().demandCommand().command(
|
||||
'verify', 'Verify the NgBot config', {}, () => verify());
|
||||
}
|
||||
|
||||
if (require.main === module) {
|
||||
buildNgbotParser(yargs).parse();
|
||||
}
|
|
@ -0,0 +1,31 @@
|
|||
/**
|
||||
* @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 {getRepoBaseDir} from '../utils/config';
|
||||
import {error, green, info, red} from '../utils/console';
|
||||
|
||||
export function verify() {
|
||||
/** Full path to NgBot config file */
|
||||
const NGBOT_CONFIG_YAML_PATH = resolve(getRepoBaseDir(), '.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;
|
||||
}
|
||||
}
|
Loading…
Reference in New Issue