A lightweight open source framework for efficiently managing common CI for multi projects

一个用于高效管理多个项目通用CI/CD的轻量级开源框架 | 官方网站

一、介绍

在微服务下，每一个项目仓库都需要维护独立的CI/CD，一旦CI/CD有设计升级或变更，所有仓库都需要配合做联动性调整，维护成本极高。为了解决这个问题，曾经提出过一种方案，详细请见文章 《多项目下CI管理方案的设计与实现》 。

本项目是基于文章中的远程管理方案设计而实现的一个用于高效管理多个项目通用CI的轻量级开源框架，它不但完全开箱即用，而且方便定制化开发与扩展。

二、快速上手

您可以参考 apimock-example 和 matching 项目是如何在gitlab和github中使用的

1、为您的项目添加ci.yml文件

首先，和单项目下的CI管理方式一样，在您的各个项目下添加一个.gitlab-ci.yml或.github/workflows/.github-ci.yml配置文件。在/template目录下有定义好的配置文件，您可以直接使用。

2、正常提交您的项目

添加完之后，如往常一样，正常编写并提交您的项目即可

3、CIManager开始工作

当您每次提交项目的时候，在runner机器上都会运行CIManager，它的底层运行原理如下图所示，详细运行过程可以 查看这里

三、更多文档

• 1. 使用文档
• 2. 设计文档
• 3. 常见问题

四、私有化部署

1、下载项目

无需任务复杂安装过程，直接通过Git方式clone到本地即可。

git clone https://github.com/WGrape/CIManager.git

2、部署至私有仓库

如果您不需要对CIManager框架进行扩展开发，那么直接把它提交至您的私有仓库，并在您各个项目中的.gitlab-ci.yml或.github/workflows/.github-ci.yml配置文件中的https://github.com/WGrape/CIManager.git替换为CIManager在您私有仓库中的地址即可。

3、自定义开发

本框架源码轻量简单，如果不满足您的需求，您可以在CIManager框架基础上进行自定义开发，比如新增配置检查、依赖检查等丰富和加强CI/CD的流水线功能。具体请参考设计文档文档

五、项目贡献

欢迎大家的参与，如果在您使用过程中遇到任何问题，可以随时在 ISSUE 中提问，也欢迎大家的 PR 对本项目优化。

• WGrape/matching ：基于CIManager实现在github上对CI/CD的统一管理
• apimock-example ：基于CIManager实现在gitlab上对CI/CD的统一管理