# jianmu-runner-project-group

**Repository Path**: jianmu-runners/jianmu-runner-project-group

## Basic Information

- **Project Name**: jianmu-runner-project-group
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2021-11-10
- **Last Updated**: 2024-06-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# jianmu-runner-project-group

### 介绍
同步项目组，批量幂等变更项目

项目不存在时，会创建项目；项目存在，且发生变更时，会更新项目

**注**：同步时，不包含来源为 git 的项目

### 发布到建木Hub
通过建木CI执行[sync_project_group.yml](https://gitee.com/jianmu-runners/jianmu-runner-list/blob/master/release_dsl/sync_project_group.yml) ，可发布到建木Hub

### 配置文件示例
```
groups:
  - name: xxx
    projects:
      - projects/ci_deploy.yml
      - projects/send_message.yml
```
name: 项目组的名称，没有填写时为默认组

projects: 需要导入的项目dsl文件，在git仓库根目录的相对路径

### 输入参数
```
ci_url: CI服务器url，必填
ci_username: CI用户名，必填
ci_password: CI密码，必填
git_path: git clone仓库的本地目录，必填
reconfigure_file_path: 项目组dsl文件在git仓库根目录的相对路径，必填
deletable: 是否删除项目组dsl文件中不存在的项目，非必填。默认为false，表示不删除
sortable: 是否按照项目组文件中的顺序对项目和项目组进行排序，默认为false，表示不排序
```

### 输出参数
```
succeed_number: 项目导入成功的数量。项目导入/更新成功或者项目无改动时表示导入成功
failed_number: 项目导入失败的数量。项目导入有错误日志时表示导入失败
```

### 构建docker镜像
```
# 创建docker镜像
docker build -f dockerfile/Dockerfile -t jianmurunner/sync_project_group:${version}

# 上传docker镜像
docker push jianmurunner/sync_project_group:${version}
```

### 用法
```
docker run --rm \
  -e JIANMU_CI_URL=xxx \
  -e JIANMU_CI_USERNAME=xxx \
  -e JIANMU_CI_PASSWORD=xxx \
  -e JIANMU_GIT_PATH=xxx \
  -e JIANMU_RECONFIGURE_FILE_PATH=xxx \
  -e JIANMU_DELETABLE=false \
  -e JIANMU_SORTABLE=false \
  jianmurunner/sync_project_group:${version} \
  python /usr/local/bin/project_group.py
```