CDK CI/CD 包装器 CLI
这个 CDK CI/CD 包装器 CLI是一个命令行界面(CLI)工具,旨在精简和自动化与AWS Cloud Development Kit(CDK)项目相关的各种任务. 它驱动自动驾驶管exec, (中文(简体) ), deploy-ci, (中文(简体) ), synth, (中文(简体) ), deploy, (中文(简体) ), check, (中文(简体) ), migrate)和提供一套公用事业,管理合规、安全、许可证和依赖性管理,所有这些都在一个单一的接口内.
目录
安装
要安装 CDK CI/ CD Wrapper, 您需要在您的系统上安装节点包管理器和 npm( 节点包管理器) 。 一旦具备这些先决条件,就可以使用以下命令在全球安装CDK CI/CD Wrapper:
npm install -g @cdklabs/cdk-cicd-wrapper-cli
或者,你可以使用 npx 命令运行 CDK CI/CD Wrapper CLI 不在全球安装:
npx @cdklabs/cdk-cicd-wrapper-cli [command]
使用量
CDK CI/CD Wrapper CLI 提供了多个命令来帮助您管理您的 CDK 项目的各个方面. 以下是可用的命令及其描述:
自动驾驶管道命令
这些命令驱动自动驾驶器( U)1.x(a) 由配置驱动的管道 cicd.config.ts。运行其中任何一个 --help 用于全旗套装(--help 具有权威性,而且始终是当前的:
npx cdk-cicd <command> --help
实验. Autopilot 管道命令是预发的,仍在演变中;旗帜和行为可能在
1.0释放.
| 命令 | 说明 |
|---|---|
exec | 在包装器下运行一个 CDK 应用程序——每个引擎激活管道的单一切入点,读取引擎和相片从 cicd.config从 cdk.json 作为 "app": "npx cdk-cicd exec bin/app.ts"。 。 。 . |
synth | 每个阶段/地区合成应用程序( S)--stage,或 --all (c) 用于完全的CI验证). |
deploy | 合成、漂移检查和在各区域部署一个舞台--stage),或运行容器模式执行器(--from-image) (中文(简体) ). |
deploy-ci | 提供管道本身进入枢纽账户,从 cicd.config.ts 单靠手操作的指令;之后的一切都是部署应用程序的管道. --disposable 泪从管道的 文物桶和钥匙与堆放. |
check | 运行默认的 CI 检查( R)validate, (中文(简体) ), audit, (中文(简体) ), license, (中文(简体) ), security)——默认建设步骤. |
migrate | 生成自动驾驶器 cicd.config.ts 从现有的 0.x PipelineBlueprint 条目文件( e)--entry, (中文(简体) ), --application, (中文(简体) ), --dry-run) (中文(简体) ). |
见 CLI 参考 用于完整命令文件.
合规小桶
这个 npx @cdklabs/cdk-cicd-wrapper-cli compliance-bucket 命令创建 S3 桶,用于遵守目的.
安全扫描
这个 npx @cdklabs/cdk-cicd-wrapper-cli security-scan 命令扫描您的代码库安全漏洞。 您可以阅读更多关于内部安全功能的信息 安全开发者指南。 。 。 .
许可证管理
这个 npx @cdklabs/cdk-cicd-wrapper-cli license 命令可以为您的工程验证和生成一个 NOTICE 文件。 NOTICE文件的一致性由这个命令进行测试,并包含在"代码Pipeline Building"步骤中,以确保文件总是最新的.
要更新 NOTICE 文件, 请运行以下命令 :
npx @cdklabs/cdk-cicd-wrapper-cli license --fix
许可证管理配置
许可证管理脚本配置可以在 licensecheck.json 文档。 以下是示例配置:
{
"failOnLicenses": ["MIT License"],
"npm": {
"excluded": [],
"excludedSubProjects": ["./example/package.json"]
},
"python": {
"excluded": [],
"excludedSubProjects": ["./example/Pipfile"]
}
}
- 被禁许可证可列入
failOnLicenses属性。 牌照名称匹配对大小写敏感. - 子文件夹
Pipfile或者说package.json档案应排除在许可证检查之外,应列在npm.excludedSubProjects或者说python.excludedSubProjects属性. - 对于国家防范机制软件包,子文件夹还需要包含
package-lock.json文件,以确保正确的依赖性被安装和检查. - 对国家预防机制和Python的许可证核查也可排除依赖.
关于许可证管理配置选项的更多信息,请参阅 许可证管理配置 节.
检查依赖关系
这个 npx @cdklabs/cdk-cicd-wrapper-cli check-dependencies 命令审计您的项目的依赖性.
校验
这个 npx @cdklabs/cdk-cicd-wrapper-cli validate 命令确保 package-lock.json 文件没有被篡改.
捐款
欢迎向CDK CI/CD Wrapper捐款! 若您愿意贡献,请遵循本报告概述的准则 捐款额 文档.
许可证
CDK CI/CD Wrapper CLI根据 Apache 2.0 许可证。 。 。 .