https://github.com/wgrape/cimanager
A lightweight open source framework for efficiently managing common CI/CD for multi projects / 一个用于高效管理多个项目通用CI/CD的轻量级开源框架
https://github.com/wgrape/cimanager
ci cicd devops gitlab golang
Last synced: about 1 month ago
JSON representation
A lightweight open source framework for efficiently managing common CI/CD for multi projects / 一个用于高效管理多个项目通用CI/CD的轻量级开源框架
- Host: GitHub
- URL: https://github.com/wgrape/cimanager
- Owner: WGrape
- License: mit
- Created: 2022-08-09T14:18:46.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-05T11:48:39.000Z (about 1 year ago)
- Last Synced: 2025-04-24T00:03:59.087Z (about 1 month ago)
- Topics: ci, cicd, devops, gitlab, golang
- Language: Shell
- Homepage: https://wgrape.github.io/CIManager/
- Size: 139 KB
- Stars: 23
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
A lightweight open source framework for efficiently managing common CI for multi projects
一个用于高效管理多个项目通用CI/CD的轻量级开源框架 | 官方网站
## 一、介绍
在微服务下，每一个项目仓库都需要维护独立的```CI/CD```，一旦```CI/CD```有设计升级或变更，所有仓库都需要配合做联动性调整，维护成本极高。为了解决这个问题，曾经提出过一种方案，详细请见文章 [《多项目下CI管理方案的设计与实现》](https://github.com/WGrape/Blog/issues/249) 。
本项目是基于文章中的```远程管理```方案设计而实现的一个用于高效管理多个项目通用CI的轻量级开源框架，它不但完全开箱即用，而且方便定制化开发与扩展。
## 二、快速上手
> 您可以参考 [apimock-example](https://jihulab.com/WGrape/apimock-example/) 和 [matching](https://github.com/WGrape/matching) 项目是如何在```gitlab```和```github```中使用的
### 1、为您的项目添加ci.yml文件
首先，和单项目下的CI管理方式一样，在您的各个项目下添加一个```.gitlab-ci.yml```或```.github/workflows/.github-ci.yml```配置文件。在```/template```目录下有定义好的配置文件，您可以直接使用。
### 2、正常提交您的项目
添加完之后，如往常一样，正常编写并提交您的项目即可
### 3、CIManager开始工作
当您每次提交项目的时候，在runner机器上都会运行CIManager，它的底层[运行原理](https://github.com/WGrape/Blog/issues/249)如下图所示，详细运行过程可以 [查看这里](https://jihulab.com/WGrape/apimock-example/-/pipelines)
## 三、更多文档
- [1. 使用文档](./doc/USAGE.md)
- [2. 设计文档](./doc/DESIGN.md)
- [3. 常见问题](./doc/QA.md)
## 四、私有化部署
### 1、下载项目
无需任务复杂安装过程，直接通过Git方式clone到本地即可。
```bash
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```的流水线功能。具体请参考[设计文档文档](./doc/DESIGN.md)
## 五、项目贡献
欢迎大家的参与，如果在您使用过程中遇到任何问题，可以随时在 [ISSUE](https://github.com/WGrape/CIManager/issues) 中提问，也欢迎大家的 [PR](https://github.com/WGrape/CIManager/pulls) 对本项目优化。
- [WGrape/matching](https://github.com/WGrape/matching) ：基于CIManager实现在github上对CI/CD的统一管理
- [apimock-example](https://jihulab.com/WGrape/apimock-example/) ：基于CIManager实现在gitlab上对CI/CD的统一管理
