TAOS-CI 项目安装与使用指南

TAOS-CI 项目安装与使用指南

1. 项目目录结构及介绍

TAOS-CI 项目的目录结构如下：

TAOS-CI/
├── ci/
│   ├── doc/
│   │   └── how-to-use-taos-ci-module.md
│   ├── taos/
│   │   ├── plugins-base/
│   │   ├── plugins-good/
│   │   ├── plugins-staging/
│   │   ├── webapp/
│   │   └── ...
│   └── ...
├── config/
│   ├── config-plugins-prebuild.sh
│   ├── config-plugins-postbuild.sh
│   └── ...
├── CMakeLists.txt
├── CODE_OF_CONDUCT.md
├── LICENSE
├── README.md
└── ...

目录结构介绍

• ci/: 包含项目的核心代码和文档。
  • doc/: 存放项目的文档文件，如 how-to-use-taos-ci-module.md。
  • taos/: 包含插件和Web应用的相关代码。
    • plugins-base/: 存放基础插件。
    • plugins-good/: 存放高质量插件。
    • plugins-staging/: 存放正在开发中的插件。
    • webapp/: 存放Web应用相关代码。
• config/: 包含项目的配置文件，如 config-plugins-prebuild.sh 和 config-plugins-postbuild.sh。
• CMakeLists.txt: CMake 构建文件。
• CODE_OF_CONDUCT.md: 项目的行为准则。
• LICENSE: 项目的许可证文件。
• README.md: 项目的介绍和使用说明。

2. 项目启动文件介绍

TAOS-CI 项目的启动文件主要是通过配置文件和插件来实现的。项目的启动流程如下：

1. 配置文件加载: 项目启动时会加载 config/config-plugins-prebuild.sh 和 config/config-plugins-postbuild.sh 配置文件。
2. 插件加载: 根据配置文件中的设置，加载相应的插件。插件主要存放在 ci/taos/plugins-base/, ci/taos/plugins-good/, 和 ci/taos/plugins-staging/ 目录中。
3. Web应用启动: 如果需要启动Web应用，可以通过 ci/taos/webapp/ 目录中的相关脚本启动。

3. 项目的配置文件介绍

TAOS-CI 项目的主要配置文件存放在 config/ 目录中，主要包括以下几个文件：

• config-plugins-prebuild.sh: 预构建阶段的插件配置文件。
• config-plugins-postbuild.sh: 后构建阶段的插件配置文件。

配置文件示例

# config-plugins-prebuild.sh
format_plugins[++idx]="pr-prebuild-[module_name]"
echo "$[format_plugins[idx]] is starting"
echo "[MODULE] $[BOT_NAME]/$[format_plugins[idx]]: Check a syntax error in a shell script file"
echo "[DEBUG] The current path: $(pwd)"
echo "[DEBUG] source $[REFERENCE_REPOSITORY]/ci/taos/plugins-good/$[format_plugins[idx]].sh"
source $[REFERENCE_REPOSITORY]/ci/taos/plugins-good/$[format_plugins[idx]].sh

配置文件说明

• format_plugins: 定义需要加载的插件。
• echo: 输出调试信息。
• source: 加载插件脚本。

通过修改这些配置文件，可以自定义项目的启动流程和插件加载顺序。