Gemeente Nijmegen projen项目类型
该存储库包含一个国家预防机制软件包,可用于创建一个新的Projen AWS CDK App项目.
项目类型 GemeenteNijmegenCdkApp 提供一些默认配置,并提供我们组织内部使用的特性. 有以下资料:
- 与 CloudFormation 模板 diffs 在 PR 上的评论
- Cfn-lint Github 克洛克流
- 缺陷配置值
Github 秘密( Github 机密 )
这种项目类型依赖于Github的机密设定,以便其所有Github工作流程都能够工作.
| 环境变量 | 解释 |
|---|---|
| (原始内容存档于2018-09-21) (英语). GITHUB PROJEN TOKEN | Projen Github个人访问标志 |
| 摇摆一回 | 这是用于紧急工作流程的 URL 发布以放松 |
使用此项目类型
新项目
npx projen new --from @gemeentenijmegen/projen-project-type {type}
可使用下列项目类型:
cdk-app标准 CDK 项目cdk-lib标准 CDK 构建库(默认向国家预防机制发布)jsii-liba JSII申请(默认向国家预防机制发布)ts-lib(默认情况下向国家预防机制公布)ts-app不发布或 cdk 的打字程序
向 cdk- app 添加样本文件
npx projen new --from @gemeentenijmegen/projen-project-type cdk-app --makeSampleFiles
现有项目
关于如何在现有项目中开始使用项目类型的指示,请参见: 设置指南。 。 。 . 注:如果切换到 awscdk-app-ts projen 项目类型,请参见 设置指南。 。 。 .
属性概览
Projen提供了一些相关的属性
| 财产 | 默认 | 解释 |
|---|---|---|
| cdk 维相 | "2.1.0" (中文(简体) ) | 要使用的 cdk 最小版本( 使用 projen 升级任务升级) |
| 默认释放宽度 | 关键 | 应确定为接受 |
| 名称 | 项目名称 | 设置工程名称 |
| 吉提格诺尔 | 一些默认被忽略的文件被设定为我们的项目 | |
| 脚本 | Cfn-lint 脚本被添加到所配置的脚本列表中 | |
| 许可证 | 欧盟PL-1.2 | 我们使用的废牌照 |
| 升级选项 | 更新工作流程配置(处: acceptance,标签: cfn-diff(中文(简体) ) |
此 npm 包中的项目类型提供了一些额外的配置选项:
| 财产 | 默认 | 解释 |
|---|---|---|
| 启用 CfnLintOnGithub | 真实 | 启用 Github 中运行 Cfn-lint 的工作流程 |
| 紧急程序 | 真实 | 将紧急程序工作流程添加到 Github 工作流程 |
| 启用自动寄存器 | 真实 | 将 PR 的自动合并工作流程添加到接受( 从升级工作流程) |
升级依赖关系
启用 Github 工作流程 zijn stalaard 中的 De 升级依赖任务 。 Deze tax zal de laatste versies van de de de de de delendenies zoneken (伏尔根语) 语义读取升级于德 package.json。 。 。 .
Dit 项目类型 zet de de de de default 分支 voor het uitvoeren van de groups op acceptance。 。 。 .
De Github 工作流程 voert de 升级依赖性 taak uit en maakt een PR naar acceptance een 标签 cfn-diff 内 auto-merge。 。 。 .
自动合并工作流程
解除自动工作流程 gaat af als een PR acceptance 母鸡在母鸡标签上 auto-merge 母鸡。 Deze 探测器 het PR te 合并遇到自动相接
(原始内容存档于2018-10-29). Field van Github. Het Github项目中的Hiervoor moet 自动化作aan staan. 编号: Zorg dat 分支保护 aan staat voor 接受,满足 de eis dat aan
伏尔达安是。 Anders kan de auto-merge worden uitgevoerd voordat de build supcesvol is. 互联网档案馆的存檔,存档日期2013-12-02.
CDK 升级
Projen中的 De 升级依赖性taak 包含 CDK versie 。 最小 Versie 字词 .projenrc.js 范·恩项目摄入.
Dit betkent Dat: (英语)
- 瓦纳
cdkVersion: '2.1.0gebruikt 单词以德表示.projenrc.js以单位表示package.json单词 :"aws-cdk-lib": "^2.1.0" - Wanner de 升级依赖性
package.json单词 :"aws-cdk-lib": "^2.31.0" - 语义性版本为zorgt er voor dat er nooit en major 升级单词gedaan omdat deze bracking 更改为 kan hebben.
Projen 升级
De projen versie wordt ook 在去升级的依赖性任务中实现高等.
本地测试
通过运行可以测试本地创建的项目
# Run the extract command on this project
cd /path/to/the/package/modules-projen && npx projen extract
# Create a new test project
mkdir test-project
cd test-project
npx projen new --from file://path/to/the/package/modules-projen/dist/js/package cdk-app