# 示例项目创建配置参数说明
# 基础信息配置
# 项目必填信息说明
填写项目名称-自行填写名称
填写项目编码-项目编码具有唯一性
添加项目成员-默认添加创建人为项目成员，其他成员可自行添加，添加的人员默认为开发人员角色
# 项目选填信息说明
勾选创建构建和发布定义-勾选后需要根据指示选择组件类型，系统将根据对应组件类型模板创建对应构建定义和发布定义
选择tomcat模板-会根据demowar模板创建组件、部署设计、构建定义和发布定义
选择springboot模板-会根据demojar模板创建组件、部署设计、构建定义和发布定义
填写代码库信息-填写了代码库信息后会自动关联代码库到该项目，并创建代码提交触发的webhook回调。
填写介质库信息-填写了介质库信息后会自动关联介质库到该项目，并且构建定义中发布程序包和数据包会自动发布到该介质库
填写资源信息-填写了资源信息后会自动关联云主机到该项目，并且发布定义中资源变量自动选择该资源
点击确认创建项目后会触发一次异步的该项目的报表统计，统计结束将会产生工作项和代码报表数据。
构建和发布暂无历史报表数据，自动触发是用于后续生成工作日每日的构建发布报表数据，若不需要可自行关闭。
# 项目基础生成数据说明
必填信息会包括如下操作：
创建项目计划
创建项目版本
创建项目版本里程碑
创建项目模块
创建项目项目里程碑
创建项目基线
创建里程碑下的交付物
为里程碑项目立项阶段和需求分析完成阶段创建工作项前置依赖
创建迭代并关联到计划
创建迭代阶段
为进行中迭代的需求评审阶段和上线阶段创建交付物
为进行中迭代的上线阶段创建工作项前置依赖
创建故事，任务，缺陷工作项并绑定对应项目版本，项目模块以及项目迭代
创建任务共享过滤器
创建工作项对应的变更历史记录
对于处理中的工作项创建演示用的代码提交记录
创建测试用例组
创建测试用例并绑定故事类型工作项
创建测试用例计划
创建测试用例测试实例
创建测试用例实例测试结果并绑定缺陷类型工作项
创建周报
# 项目选填信息生成数据说明
勾选创建构建和发布定义并完成代码库、介质库和资源的配置
填写了代码库信息后会自动关联代码库到该项目，并创建代码提交触发的webhook回调。
填写了介质库信息后会自动关联介质库到该项目，并且构建定义中发布程序包和数据包会自动发布到该介质库
填写了资源信息后会自动关联云主机到该项目，并且发布定义中资源变量自动选择该资源
若勾选了周期发布定时，会自动为构建定义和发布定义创建每周一到周五凌晨0:05周期触发的定时任务
会自动创建代码库的代码提交触发构建定义策略
勾选后需要选择需要适用的构建发布模板
选择tomcat模板
选择此选项会包括如下操作：
创建demoWar名称的tomcat类型程序组件和demoData名称的mysql类型的数据组件
创建demoWar的部署设计图
创建名称为demowar-build的构建定义并关联了对应组件，详细内容参考示例构建配置部分。
创建名称为demowar-release的发布定义并关联了对应部署设计，详细内容参考示例发布配置部分。
选择springboot模板
选择此选项会包括如下操作：
创建demoJar名称的springboot类型程序组件和demoData名称的mysql类型的数据组件
创建demoJar的部署设计图
创建名称为demojar-build的构建定义并关联了对应组件，详细内容参考示例构建配置部分。
创建名称为demojar-release的构建定义并关联了对应部署设计，详细内容参考示例发布配置部分。
# 示例项目构建定义参数配置说明
# 构建定义原子任务配置说明
所有关键的配置信息都抽成了变量，可以在变量页面查看赋予的初值。
接下来会详细介绍每个参数的作用，被赋予了初值的变量可以按需要调整或保持不变。
注意： *下文加粗的内容需要人为更新变量的值
# 拉取Git代码
从添加的代码库拉取源代码。
涉及的变量：
自动填充
codeUrl.url：创建项目时填写的代码库信息。
codeBranch：默认值为master，可按需求更改。
# Maven执行
编译Maven类型的工程。
涉及的变量：
自动填充
mavenGoals：预设了clean package org.cyclonedx:cyclonedx-maven-plugin:makeAggregateBom 命令用于生成bom.xml物料清单。
# 发布程序包
发布程序介质到nexus仓库。
涉及的变量：
自动填充
objArtifactPath：程序工件路径，demoJar默认值为target/*.jar，demoWar默认值target/*.war。
objArtifactId：程序artifactId，demoJar/demoWar。
artifactVersion：构建版本，默认取当前项目进行中的版本的结束时间。
objAliasName：程序别名，demoJar/demoWar。
objTargetComponent.id：程序对应组件id，demoJar/demoWar组件。
*手动调整
*artifactRepositoryId：介质仓库ID，如果创建项目时关联了介质库，此处会默认填充对应的介质库ID；如果没有关联介质库，或者需要变更介质库时，可自行选择下拉框范围的其他介质库。
*performFlag：忽略介质上传以及安全扫描执行标识，该值默认为忽略（true），用于人工没有配置构建信息时，仍能在周期构建时保证构建的成功执行。当需要上传介质和安全扫描时，需要将该值置为开启（false）。
# 发布数据包
发布数据脚本包到nexus仓库。
涉及的变量：
自动填充
dataArtifactPath：数据包路径，默认值target/*.zip。
dataArtifactId：数据artifactId，demoData。
artifactVersion：构建版本，默认取当前项目进行中的版本的结束时间。
dataAliasName：数据别名，demoData。
dataTargetComponent.id：数据对应组件id，demoData组件。
*手动调整
*artifactRepositoryId：介质仓库ID，如果创建项目时关联了介质库，此处会默认填充对应的介质库ID；如果没有关联介质库，或者需要变更介质库时，可自行选择下拉框范围的其他介质库。
*performFlag：忽略介质上传以及安全扫描执行标识，该值默认为忽略（true），用于人工没有配置构建信息时，仍能在周期构建时保证构建的成功执行。当需要上传介质和安全扫描时，需要将该值置为开启（false）。
# SonarQube代码扫描
*注意：为了保证示例构建正常执行，推荐使用sonarqube9以上版本
代码质量检测。
涉及的变量：
自动填充
sonarProjectSettingsContent：sonarqube扫描配置文件，可根据需要自行修改
*手动调整
*sonarServerId：sonarqube服务ID，需要自行选择，不选择时执行该原子任务时会报错提示。
*performFlag：忽略介质上传以及安全扫描执行标识，该值默认为忽略（true），用于人工没有配置构建信息时，仍能在周期构建时保证构建的成功执行。当需要上传介质和安全扫描时，需要将该值置为开启（false）。
# DependencyTrack介质扫描
*注意：为了保证示例构建正常执行，需要提前在平台参数中配置DependencyTrack服务地址与ApiKey
jenkins引擎推荐2.361及以上版本
介质物料清单检测。
涉及的变量：
自动填充
objArtifactPath：程序工件路径，demoJar默认值为target/*.jar，demoWar默认值target/*.war。
objArtifactId：artifactID，demoJar/demoWar。
artifactVersion：构建版本，默认取当前项目进行中的版本的结束时间。
*手动调整
*performFlag：忽略介质上传以及安全扫描执行标识，该值默认为忽略（true），用于人工没有配置构建信息时，仍能在周期构建时保证构建的成功执行。当需要上传介质和安全扫描时，需要将该值置为开启（false）。
# 构建定义变量说明
以demojar构建定义为例，此处展示了相关的所有变量，可以直观的了解需要人工确认的参数。
未标注需要确认的变量会按模板赋上初始值，按需求修改。
| 变量 | 默认值 | 描述 | 人工确认 |
|---|---|---|---|
| performFlag | 忽略（true） | 忽略介质上传以及安全扫描执行标识 | 需要 |
| codeUrl | 创建时输入的代码库地址 | 代码库地址 | |
| codeBranch | master | 代码库分支 | |
| mavenGoals | clean package org.cyclonedx: cyclonedx-maven-plugin:makeAggregateBom | mavn指令 | |
| objArtifactPath | target/*.jar | 程序工件路径 | |
| objArtifactId | demoJar | 程序artifactId | |
| artifactVersion | 默认取当前项目进行中的版本的结束时间 | 构建版本 | |
| objAliasName | demoJar | 程序别名 | |
| objTargetComponent | demoJar组件 | 程序对应组件 | |
| artifactRepositoryId | 如果创建项目时关联了介质库，此处会默认填充对应的介质库ID | 介质仓库 | 需要 |
| sonarProjectSettingsContent | sonar.projectKey=com.primeton.demo:demojar sonar.projectName=demojar sonar.projectVersion=1.0.0 sonar.sources=. sonar.sourceEncoding=UTF-8 sonar.java.binaries=target/classes | sonarqube配置文件内容 | |
| dataArtifactPath | target/*.zip | 数据工件路径 | |
| dataArtifactId | demoData | 数据artifactId | |
| dataAliasName | demoData | 数据别名 | |
| dataTargetComponent | demoData组件 | 数据对应组件 | |
| description | demoJar构建定义示例 | 构建定义描述 |
# 
# 示例项目发布定义参数配置说明
因为demoWar和demoJar的发布介质类型不同，下文将分别进行配置说明。
# 部署环境准备
发布前为了保证部署的正常进行，需要做如下准备
# 资源的连通性检测
保证项目创建时的资源能正常连接访问。
# 数据库服务器配置
推荐在部署-服务的菜单页面配置Mysql云主机，如果数据库服务已经安装，可以在高级中勾选已安装。不配置的话不影响数据组件发布，请自行保证发布时配置的数据服务器Ip端口可用即可。
# demoJar发布定义发布环境配置说明
所有关键的配置信息都抽成了变量，可以在变量配置页面查看赋予的初值。
接下来会详细介绍每个参数的作用，被赋予了初值的变量可以按需要调整或保持不变。
注意： *下文加粗的内容需要人为更新变量的值
# 文件生成
生成demoJar数据库连接配置文件
涉及的变量：
*手动调整
*mysqlHostIp：数据库主机IP，需要自行配置。
*mysqlHostPort：数据库端口，需要自行配置。
*databaseName：数据库名称，需要自行配置。
*userName：数据库连接用户名，需要自行配置。
*password：数据库密码，需要自行配置。
*resourceId：默认值为项目创建时配置的资源ID，可按需求更改。
*performFlag：忽略发布中的原子任务，该值默认为忽略（true），用于人工没有配置构建信息时，仍能在周期构建时保证发布的成功执行。当需要部署环境时，需要将该值置为开启（false）。
# 数据组件发布
组件部署：数据组件发布
涉及的变量：
*手动调整
*dataComponentName.name：数据组件名称，默认值为demoData。
*mysqlHostIp：数据库部署主机，需要自行配置。
*mysqlHostPort：数据库端口，需要自行配置。
*databaseName：数据库名称，需要自行配置。
*userName：数据库连接用户名，需要自行配置。
*password：数据库密码，需要自行配置。
*dataArtifactRepositoryId：数据介质库ID，需要自行选择对应介质库。
*dataArtifactVersion：数据介质版本，需要自行选择对应版本。
*performFlag：忽略发布中的原子任务，该值默认为忽略（true），用于人工没有配置构建信息时，仍能在周期构建时保证发布的成功执行。当需要部署环境时，需要将该值置为开启（false）。
# springboot云主机部署
组件部署：从云主机部署
涉及的变量：
自动填充
userDir：默认值为/opt/idc/apps。
springbootDir：默认值为springboot。
*手动调整
*objComponentName.name：程序组件名称，默认值为demoJar。
*objArtifactRepositoryId：程序介质库ID，需要自行选择对应介质库。
*objArtifactVersion：程序介质版本，需要自行选择对应版本。
*resourceId：默认值为项目创建时配置的资源ID，可按需求更改。
*springbootPort：demoJar服务的端口，默认值9999，可按需求更改。
*performFlag：忽略发布中的原子任务，该值默认为忽略（true），用于人工没有配置构建信息时，仍能在周期构建时保证发布的成功执行。当需要部署环境时，需要将该值置为开启（false）。
# demoJar发布定义变量说明
此处展示了相关的所有变量，可以直观的了解需要人工确认的参数。
未标注需要确认的变量会按模板赋上初始值，按需求修改。
| 变量 | 默认值 | 描述 | 人工确认 |
|---|---|---|---|
| performFlag | 忽略(true) | 忽略数据和应用部署标识 | 需要 |
| mysqlHostIp | 数据库主机IP | 需要 | |
| mysqlHostPort | 数据库端口 | 需要 | |
| databaseName | 数据库部署主机 | 需要 | |
| userName | 数据库连接用户名 | 需要 | |
| password | 数据库密码 | 需要 | |
| dataComponentName | demoData | 数据组件名称 | 需要 |
| dataArtifactRepositoryId | 数据介质库ID | 需要 | |
| dataArtifactVersion | 数据版本 | 需要 | |
| objComponentName | demoJar | 应用组件名称 | 需要 |
| objArtifactRepositoryId | 应用介质库ID | 需要 | |
| objArtifactVersion | 应用介质版本 | 需要 | |
| springbootDir | springboot | 安装根路径 | |
| userDir | /opt/idc/apps | 用户路径 | |
| resourceId | 创建项目时填写的资源ID | 主机资源ID | 需要 |
| springbootPort | 9999 | springboot应用端口 | 需要 |
| description | demoJar发布定义示例 | 描述 | |
| deployDesignId | 自动获取dmoJar部署设计 | 部署设计ID |
# 
# demoWar发布定义发布环境配置说明
所有关键的配置信息都抽成了变量，可以在变量配置页面查看赋予的初值。
接下来会详细介绍每个参数的作用，被赋予了初值的变量可以按需要调整或保持不变。
注意： *下文加粗的内容需要人为更新变量的值
# 文件生成
生成demoJar数据库连接配置文件
涉及的变量：
*手动调整
*mysqlHostIp：数据库主机IP，需要自行配置。
*mysqlHostPort：数据库端口，需要自行配置。
*databaseName：数据库名称，需要自行配置。
*userName：数据库连接用户名，需要自行配置。
*password：数据库密码，需要自行配置。
*resourceId：默认值为项目创建时配置的资源ID，可按需求更改。
*performFlag：忽略发布中的原子任务，该值默认为忽略（true），用于人工没有配置构建信息时，仍能在周期构建时保证发布的成功执行。当需要部署环境时，需要将该值置为开启（false）。
# 数据组件发布
组件部署：数据组件发布
涉及的变量：
*手动调整
*dataComponentName.name：数据组件名称，默认值为demoData。
*mysqlHostIp：数据库部署主机Ip，需要自行配置。
*mysqlHostPort：数据库端口，需要自行配置。
*databaseName：数据库名称，需要自行配置。
*userName：数据库连接用户名，需要自行配置。
*password：数据库密码，需要自行配置。
*dataArtifactRepositoryId：数据介质库ID，需要自行选择对应介质库。
*dataArtifactVersion：数据介质版本，需要自行选择对应版本。
*performFlag：忽略发布中的原子任务，该值默认为忽略（true），用于人工没有配置构建信息时，仍能在周期构建时保证发布的成功执行。当需要部署环境时，需要将该值置为开启（false）。
# tomcat云主机部署
组件部署：从云主机部署
涉及的变量：
自动填充
userDir：默认值为/opt/idc/apps。
tomcatDir：默认值为tomcat8。
*手动调整
*objComponentName.name：程序组件名称，默认值为demoWar。
*objArtifactRepositoryId：程序介质库ID，需要自行选择对应介质库。
*objArtifactVersion：程序介质版本，需要自行选择对应版本。
*tomcatResources：默认值为项目创建时配置的资源ID，可按需求更改。
*httpPort：demoWar服务的端口，默认值28080，可按需求更改。
*sslPort：SSL监听端口，默认值28443，可按需求更改。
*serverPort：Shutdown端口，默认值28005，可按需求更改。
*ajpPort：AJP端口，默认值28009，可按需求更改。
*performFlag：忽略发布中的原子任务，该值默认为忽略（true），用于人工没有配置构建信息时，仍能在周期构建时保证发布的成功执行。当需要部署环境时，需要将该值置为开启（false）。
# demoWar发布定义变量说明
此处展示了相关的所有变量，可以直观的了解需要人工确认的参数。
未标注需要确认的变量会按模板赋上初始值，按需求修改。
| 变量 | 默认值 | 描述 | 人工确认 |
|---|---|---|---|
| performFlag | 忽略(true) | 忽略数据和应用部署标识 | 需要 |
| mysqlHostIp | 数据库主机IP | 需要 | |
| mysqlHostPort | 数据库端口 | 需要 | |
| databaseName | 数据库部署主机 | 需要 | |
| userName | 数据库连接用户名 | 需要 | |
| password | 数据库密码 | 需要 | |
| dataComponentName | demoData | 数据组件名称 | 需要 |
| dataArtifactRepositoryId | 数据介质库ID | 需要 | |
| dataArtifactVersion | 数据版本 | 需要 | |
| objComponentName | demoWar | 应用组件名称 | 需要 |
| objArtifactRepositoryId | 应用介质库ID | 需要 | |
| objArtifactVersion | 应用介质版本 | 需要 | |
| tomcatResources | 自动获取项目创建时填写的资源 | 服务器资源 | 需要 |
| description | demoWar部署定义示例 | 发布定义描述 | |
| deployDesignId | 自动获取dmoWar部署设计 | 部署设计ID | |
| userDir | /opt/idc/apps | tomcat安装目录 | |
| tomcatDir | tomcat8 | tomcat安装目录 | |
| httpPort | 28080 | HTTP监听端口 | 需要 |
| sslPort | 28443 | SSL监听端口 | 需要 |
| serverPort | 28005 | Shutdown端口 | 需要 |
| ajpPort | 28009 | AJP端口 | 需要 |
