projen
Version:
CDK for software projects
64 lines • 11.1 kB
JavaScript
;
var _a;
Object.defineProperty(exports, "__esModule", { value: true });
exports.DependencyReview = void 0;
const JSII_RTTI_SYMBOL_1 = Symbol.for("jsii.rtti");
const workflow_steps_1 = require("./workflow-steps");
const workflows_model_1 = require("./workflows-model");
const component_1 = require("../component");
const runner_options_1 = require("../runner-options");
/**
* Adds a GitHub workflow that runs the dependency-review-action on pull requests.
*
* This action scans pull requests for dependency changes and raises an error
* if any vulnerabilities or invalid licenses are introduced.
*
* @see https://github.com/actions/dependency-review-action
*/
class DependencyReview extends component_1.Component {
constructor(github, options = {}) {
super(github.project);
const commentSummary = options.commentSummaryInPr ?? "always";
const workflow = github.addWorkflow("dependency-review");
workflow.on({
pullRequest: {},
workflowDispatch: {},
});
workflow.addJobs({
"dependency-review": {
...(0, runner_options_1.filteredRunsOnOptions)(options.runsOn, options.runsOnGroup),
permissions: {
contents: workflows_model_1.JobPermission.READ,
...(commentSummary !== "never"
? { pullRequests: workflows_model_1.JobPermission.WRITE }
: {}),
},
steps: [
workflow_steps_1.WorkflowSteps.checkout(),
{
name: "Dependency Review",
uses: "actions/dependency-review-action@v4",
with: {
"fail-on-severity": options.failOnSeverity,
"allow-licenses": options.allowLicenses?.join(", "),
"vulnerability-check": options.vulnerabilityCheck,
"license-check": options.licenseCheck,
"fail-on-scopes": options.failOnScopes?.join(", "),
"config-file": options.configFile,
"allow-ghsas": options.allowGhsas?.join(", "),
"deny-packages": options.denyPackages?.join(", "),
"comment-summary-in-pr": commentSummary,
"warn-only": options.warnOnly,
"show-openssf-scorecard": options.showOpenSSFScorecard,
"warn-on-openssf-scorecard-level": options.warnOnOpenSSFScorecardLevel,
},
},
],
},
});
}
}
exports.DependencyReview = DependencyReview;
_a = JSII_RTTI_SYMBOL_1;
DependencyReview[_a] = { fqn: "projen.github.DependencyReview", version: "0.99.51" };
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"dependency-review.js","sourceRoot":"","sources":["../../src/github/dependency-review.ts"],"names":[],"mappings":";;;;;AACA,qDAAiD;AACjD,uDAAkD;AAClD,4CAAyC;AAEzC,sDAA0D;AAuG1D;;;;;;;GAOG;AACH,MAAa,gBAAiB,SAAQ,qBAAS;IAC7C,YAAY,MAAc,EAAE,UAAmC,EAAE;QAC/D,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAEtB,MAAM,cAAc,GAAG,OAAO,CAAC,kBAAkB,IAAI,QAAQ,CAAC;QAE9D,MAAM,QAAQ,GAAG,MAAM,CAAC,WAAW,CAAC,mBAAmB,CAAC,CAAC;QACzD,QAAQ,CAAC,EAAE,CAAC;YACV,WAAW,EAAE,EAAE;YACf,gBAAgB,EAAE,EAAE;SACrB,CAAC,CAAC;QAEH,QAAQ,CAAC,OAAO,CAAC;YACf,mBAAmB,EAAE;gBACnB,GAAG,IAAA,sCAAqB,EAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,WAAW,CAAC;gBAC7D,WAAW,EAAE;oBACX,QAAQ,EAAE,+BAAa,CAAC,IAAI;oBAC5B,GAAG,CAAC,cAAc,KAAK,OAAO;wBAC5B,CAAC,CAAC,EAAE,YAAY,EAAE,+BAAa,CAAC,KAAK,EAAE;wBACvC,CAAC,CAAC,EAAE,CAAC;iBACR;gBACD,KAAK,EAAE;oBACL,8BAAa,CAAC,QAAQ,EAAE;oBACxB;wBACE,IAAI,EAAE,mBAAmB;wBACzB,IAAI,EAAE,qCAAqC;wBAC3C,IAAI,EAAE;4BACJ,kBAAkB,EAAE,OAAO,CAAC,cAAc;4BAC1C,gBAAgB,EAAE,OAAO,CAAC,aAAa,EAAE,IAAI,CAAC,IAAI,CAAC;4BACnD,qBAAqB,EAAE,OAAO,CAAC,kBAAkB;4BACjD,eAAe,EAAE,OAAO,CAAC,YAAY;4BACrC,gBAAgB,EAAE,OAAO,CAAC,YAAY,EAAE,IAAI,CAAC,IAAI,CAAC;4BAClD,aAAa,EAAE,OAAO,CAAC,UAAU;4BACjC,aAAa,EAAE,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC;4BAC7C,eAAe,EAAE,OAAO,CAAC,YAAY,EAAE,IAAI,CAAC,IAAI,CAAC;4BACjD,uBAAuB,EAAE,cAAc;4BACvC,WAAW,EAAE,OAAO,CAAC,QAAQ;4BAC7B,wBAAwB,EAAE,OAAO,CAAC,oBAAoB;4BACtD,iCAAiC,EAC/B,OAAO,CAAC,2BAA2B;yBACtC;qBACF;iBACF;aACF;SACF,CAAC,CAAC;IACL,CAAC;;AA7CH,4CA8CC","sourcesContent":["import type { GitHub } from \"./github\";\nimport { WorkflowSteps } from \"./workflow-steps\";\nimport { JobPermission } from \"./workflows-model\";\nimport { Component } from \"../component\";\nimport type { GroupRunnerOptions } from \"../runner-options\";\nimport { filteredRunsOnOptions } from \"../runner-options\";\n\n/**\n * Options for the DependencyReview component.\n */\nexport interface DependencyReviewOptions {\n  /**\n   * The severity level at which the action will fail.\n   *\n   * @default - no minimum severity (action default is \"low\")\n   */\n  readonly failOnSeverity?: \"low\" | \"moderate\" | \"high\" | \"critical\";\n\n  /**\n   * List of allowed SPDX license identifiers.\n   *\n   * @default - no license allow-list\n   */\n  readonly allowLicenses?: string[];\n\n  /**\n   * Enable or disable the vulnerability check.\n   *\n   * @default true\n   */\n  readonly vulnerabilityCheck?: boolean;\n\n  /**\n   * Enable or disable the license check.\n   *\n   * @default true\n   */\n  readonly licenseCheck?: boolean;\n\n  /**\n   * Scopes of dependencies to fail on.\n   *\n   * @default - no scopes filter (action default is \"runtime\")\n   */\n  readonly failOnScopes?: Array<\"runtime\" | \"development\" | \"unknown\">;\n\n  /**\n   * Path to an external configuration file.\n   *\n   * @default - no external config\n   */\n  readonly configFile?: string;\n\n  /**\n   * GitHub Advisory Database IDs that can be skipped during detection.\n   *\n   * @default - no advisories are skipped\n   */\n  readonly allowGhsas?: string[];\n\n  /**\n   * Packages to block in a PR (in purl format).\n   *\n   * @default - no packages are denied\n   */\n  readonly denyPackages?: string[];\n\n  /**\n   * Whether to post a comment summary on the PR.\n   *\n   * @default \"always\"\n   */\n  readonly commentSummaryInPr?: \"always\" | \"on-failure\" | \"never\";\n\n  /**\n   * When true, the action will only warn and not fail.\n   *\n   * @default false\n   */\n  readonly warnOnly?: boolean;\n\n  /**\n   * Show OpenSSF Scorecard scores for dependencies.\n   *\n   * @default true\n   */\n  readonly showOpenSSFScorecard?: boolean;\n\n  /**\n   * Score threshold for OpenSSF Scorecard warnings.\n   *\n   * @default 3\n   */\n  readonly warnOnOpenSSFScorecardLevel?: number;\n\n  /**\n   * Github Runner selection labels.\n   *\n   * @default [\"ubuntu-latest\"]\n   */\n  readonly runsOn?: string[];\n\n  /**\n   * Github Runner Group selection options.\n   */\n  readonly runsOnGroup?: GroupRunnerOptions;\n}\n\n/**\n * Adds a GitHub workflow that runs the dependency-review-action on pull requests.\n *\n * This action scans pull requests for dependency changes and raises an error\n * if any vulnerabilities or invalid licenses are introduced.\n *\n * @see https://github.com/actions/dependency-review-action\n */\nexport class DependencyReview extends Component {\n  constructor(github: GitHub, options: DependencyReviewOptions = {}) {\n    super(github.project);\n\n    const commentSummary = options.commentSummaryInPr ?? \"always\";\n\n    const workflow = github.addWorkflow(\"dependency-review\");\n    workflow.on({\n      pullRequest: {},\n      workflowDispatch: {},\n    });\n\n    workflow.addJobs({\n      \"dependency-review\": {\n        ...filteredRunsOnOptions(options.runsOn, options.runsOnGroup),\n        permissions: {\n          contents: JobPermission.READ,\n          ...(commentSummary !== \"never\"\n            ? { pullRequests: JobPermission.WRITE }\n            : {}),\n        },\n        steps: [\n          WorkflowSteps.checkout(),\n          {\n            name: \"Dependency Review\",\n            uses: \"actions/dependency-review-action@v4\",\n            with: {\n              \"fail-on-severity\": options.failOnSeverity,\n              \"allow-licenses\": options.allowLicenses?.join(\", \"),\n              \"vulnerability-check\": options.vulnerabilityCheck,\n              \"license-check\": options.licenseCheck,\n              \"fail-on-scopes\": options.failOnScopes?.join(\", \"),\n              \"config-file\": options.configFile,\n              \"allow-ghsas\": options.allowGhsas?.join(\", \"),\n              \"deny-packages\": options.denyPackages?.join(\", \"),\n              \"comment-summary-in-pr\": commentSummary,\n              \"warn-only\": options.warnOnly,\n              \"show-openssf-scorecard\": options.showOpenSSFScorecard,\n              \"warn-on-openssf-scorecard-level\":\n                options.warnOnOpenSSFScorecardLevel,\n            },\n          },\n        ],\n      },\n    });\n  }\n}\n"]}