跳到主要内容

快速指南

流程概览

alt text


Step 1: 导出 Seed Data

从平台导出项目的 seed-data 为 ZIP 文件。


Step 2(GitLab): 创建 GitLab 仓库和 Access Token

2.1 创建仓库

在 GitLab 中创建一个新仓库用于存储 seed-data:

示例:

  • https://gitlab.dev.xxxx.com.cn/your-org/dxsrm-seed-data.git

2.2 创建 Access Token

在 GitLab 仓库 Settings → Access Tokens 中创建 Project Access Token:

  • Role: Developer
  • Scopes: api, read_api, write_repository

示例 Token:

  • glpat-e-uzHm7mPJ3kEf5eaMKZ

⚠️ Token 创建后只显示一次,请妥善保存。


Step 2 (GitHub): 创建 GitHub 仓库和 Personal Access Token

2.1 创建仓库

在 GitHub 中创建一个新仓库用于存储 seed-data:

示例:

  • https://github.com/your-org/dxsrm-seed-data.git

建议创建 Private 仓库,避免 seed-data 泄露。

2.2 创建 Personal Access Token (PAT)

在 GitHub 中进入 Settings → Developer settings → Personal access tokens → Fine-grained tokens,创建新 Token:

  • Repository access: 选择 Only select repositories,指定目标仓库

  • Permissions:

    • Contents: Read and write(读写仓库内容)
    • Metadata: Read-only(必选)

    github config

示例 Token:

  • github_pat_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

⚠️ Token 创建后只显示一次,请妥善保存。

⚠️ Fine-grained token 有过期时间限制(最长 1 年),请注意续期。

2.3 仓库 URL 格式

在 Codifier 中配置 GitHub 仓库时,使用 HTTPS URL:

https://github.com/your-org/your-repo.git

Step 3: 配置 Codifier

3.1 创建项目

登录 Codifier 平台,进入 项目管理 页面,创建新项目:

GitLab 示例:

字段示例值
仓库 URLhttps://gitlab.dev.xxx.com.cn/project-seed-data/dxsrm-seed-data.git
Tokenglpat-e-uzHm7mPJ3kEf5eaMKZ

GitHub 示例:

字段示例值
仓库 URLhttps://github.com/your-org/dxsrm-seed-data.git
Tokenghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Step 4: 上传 ZIP 到 Codifier

在 Codifier 首页切换到 上传 标签页:

  1. 选择 Git 仓库
  2. 输入新分支名称(如 maindev1
  3. 选择 Step 1 导出的 ZIP 文件
  4. 点击「上传并处理」

系统会自动拆分 ZIP 并推送到指定分支。


Step 5: 配置 Ceta 平台 Commit 功能并提交变更

5.1 创建 Access Token(Codifier Secret)

进入 Codifier 的项目管理Secrets 页面,为项目生成访问密钥:

  • 选择项目 → 点击「生成密钥」
  • 设置有效期
  • 复制生成的 Secret

示例 Secret:v7ICDMqy1WWINY2hR_xxxxxxxxxxxxxx_mYrcSin8E

5.2 配置 commitTriggerUrl

在Ceta平台的 项目设置 > 配置管理 > 应用配置 中,配置 commit 触发 URL:

{
"client": {
"commitTriggerUrl": "https://ceta-codifier.xxx.com.cn/codifier/api/commit/dev2?X-Access-Token=v7ICDMqy1WWINY2hR_xxxxxxxxxxxxxx_mYrcSin8E"
}
}

URL 格式:

  • 如果 Access Token 所属项目与 Codifier 项目名称相同:
    {codifier地址}/api/commit/{git-分支}?X-Access-Token={secret}
  • 如果 Access Token 所属项目与 Codifier 项目名称不同,需显式指定项目名:
    {codifier地址}/api/commit/{codifier-项目名}/{git-分支}?X-Access-Token={secret}

5.3 从 Ceta Platform 发起 commit(check-in)

配置完成后,开发人员在平台中正常开发:

  • 修改 Flow、Form、Page
  • 保存后,点击 签入/check-in 按钮 commit 到 Git 仓库
  • 每次 check-in 对应一次 Git commit

Step 6: 从 Codifier 发起 批量 commit

6.1 配置 Ceta Commit Configs

在使用「Ceta Commit」功能前,需先在 项目管理 中配置 Ceta Commit Configs,用于指定从 Platform 下载 seed-data 时的连接信息:

字段说明示例值
Ceta URLPlatform 的地址https://your-platform.example.com
Ceta TokenPlatform 的 Access TokeneyJhbGciOiJIUzI1NiIs...
Project IDPlatform 中的项目 ID123

配置步骤:

  1. 进入 Codifier 项目管理 页面
  2. 选择目标项目,点击编辑
  3. 找到 Ceta Commit Configs 配置区域
  4. 填写 Platform 连接信息(URL、Token、Project ID)
  5. 保存配置

6.2 发起 Ceta Commit

配置完成后,在 Codifier 项目的指定分支,点击「Ceta Commit」按钮:

  1. Codifier 自动从 Platform 下载最新的 seeddata 包
  2. 对比当前 Git 仓库中的内容,识别变更
  3. 将变更 commit 到指定分支

适用场景:批量同步 Platform 上的变更到 Git 仓库,或在 Platform 未配置 commitTriggerUrl 时手动提交。


Step 7: 下载 SeedData 包

需要将变更应用到其他环境时:

全量下载

  • 进入 Codifier 首页 → 选择仓库 → 刷新分支 → 点击「全量下载」

Patch 模式(推荐)

  • 点击「Patch 模式」→ 选择需要的内容
  • 可使用 Git 过滤 快速定位变更(输入基准分支/标签/日期)
  • 点击「生成 Patch 包」
  • 下载 ZIP

Step 8: 应用到目标环境

将下载的 ZIP 文件导入到目标环境(如 QA 环境):

  1. 使用传统 import 脚本/API 导入 seed-data 包

常见问题

问题解决方案
分支已存在上传时使用不同的分支名
Token 过期在 GitLab 中重新创建 Access Token 并更新 Codifier 项目配置
GitHub Token 过期在 GitHub Settings → Developer settings 中重新生成 PAT 并更新 Codifier
提交未生效检查 commitTriggerUrl 配置和 Secret 是否正确
GitHub 403 错误检查 Token 权限是否包含 repo scope 或 Fine-grained token 的 Contents 权限