cicd_demo/README.md

# ModelHub CICD 使用文档

  ## 主要功能

  通过 CICD 流程实现 docker 镜像打包、上传镜像仓库的功能。

  ## 操作流程

  1. 新增 CI/CD 配置文件

     将本仓库的 `.gitea/workflows/docker-build-push.yml` 复制到你的代码仓库，并保持相同的目录路径，即放置到：

     ```text
     .gitea/workflows/docker-build-push.yml

  2. 配置 tag 正则表达式

     在 docker-build-push.yml 中找到 tags 字段，其值是一个正则表达式，表示打 tag 时要匹配这个表达式才会触发 CICD 流程。

     默认匹配以 v 开头的 tag，也可以自行修改。
  3. 配置运行环境

     如果使用昇腾加速卡，需要将 docker-build-push.yml 中 runs-on 的值修改为：

     runs-on: arm64-ubuntu-24.04

     其他加速卡的 runs-on 值与样例中保持一致，即：

     runs-on: amd64-ubuntu-24.04
  4. 新增 env 配置文件

     将本仓库的 .gitea/workflows/task_info.env 复制到你的代码仓库，并给 FRAMEWORK、GPU_TYPE、TASK_TYPE 填入实际的值。

     这些字段用于在 ModelHub 平台对镜像进行框架、GPU 类型、任务类型的归类，例如：
     ```bash
     FRAMEWORK=transformers
     GPU_TYPE=Iluvatar_bi-150
     TASK_TYPE=text-generation
     ```
  5. 打 tag 触发 CICD

     上述文件都配置好后，执行打 tag 的操作，即可触发 CICD 流程。

     可以在页面的 Actions 中看到 CICD 的执行情况。
  6. 查看执行结果

     CICD 会依次执行 docker build、docker push，以及对镜像发起审核。

     审核通过后，才可以在 ModelHub 平台上选取对应的镜像进行评测流程。