SUMMARY.md

Table of contents

• 首页

🐤 了解基本概念

• BKCI 是什么？
• BKCI 组件
• 5分钟读懂 BKCI 流水线
• 术语解释
  • Stage
  • Job
  • Task
  • Trigger
    • github事件触发
  • Variables

👉 使用 BKCI

• 创建你的第一条流水线

• 关联你的第一个代码库

• 为你的Git工程开启CI

• 示例

  • 代码拉取+制品上传+制品下载
  • 流水线触发方式使用
  • 流水线变量使用
  • 使用模板创建流水线
  • 流水线条件判断
  • 子流水线
  • Java Maven Demo
  • Node Demo

• 场景实践

  • 美术人员自助更新游戏资源
  • 运营人员发布游戏内运营活动
  • 客户端多版本构建保持一致
  • c/c++后台代码的编译加速
  • 客户端自动化性能测试
  • Pipeline失败的问题定位
  • 移动端内测版本发布管理
  • 在转测/发布时使用质量红线
  • MergeRequest时使用质量红线
  • 企业微信机器人执行流水线
  • 流水线的模版和复制
  • 管理大量流水线
  • UE引擎编译加速
  • 实现发布与回滚
  • 集成P4代码库
  • 云环境异常定位
  • 流水线互斥及排队
  • 组建私有构建集群
  • 不同流水线间调用
  • 通知发送到钉钉

• 客户案例

  • 呦尔哈--通过蓝盾提升CI/CD效率
  • 永航--通过蓝鲸蓝盾实现跨环境CICD互通
  • 宝可拉--通过按量计费的编译加速方案提升服务器端75%编译速度

🚀 部署 BKCI

• BKCI 硬件规格指南
• BKCI 系统要求
• 蓝盾备份方案

📔 产品功能

• 控制台
• 流水线
  • 流水线触发方式
    • 手动触发
    • 远程触发
    • 定时器触发
    • gitlab触发
  • 流水线列表页
  • 流水线执行历史
  • 创建/编辑流水线
    • 流水线图形化编排
    • 为流水线开启自定义构建号
    • 锁定流水线
  • 流水线任务详情页
    • 流水线状态信息汇总
  • 流水线变量
    • 变量的基本使用
    • 使用变量控制流水线流程
    • 使用备注变量
    • 凭证变量
  • 流水线视图
    • 流水线视图的使用
• 构建资源
  • 将你的构建机托管至 BKCI
    • 第三方构建机环境准备
    • 导入Windows构建机
      • windows agent启动界面程序的解决办法
  • 构建机详情页
• 凭证管理
• 代码库
• 编译加速
  • Linux C/C++ 编译加速
    • 定制Linux C/C++加速方案
    • 在流水线中进行编译加速
    • 在私有构建机上使用加速
• 制品库
  • 元数据规范
• 代码检查
  • 代码检查使用
  • 代码检查配置
  • 代码检查结果
  • 代码检查规则
  • 代码检查部署所需资源
• 移动端版本体验
  • 部署移动端版本体验需要的硬件资源
  • 移动端版本体验使用指南
• bkchat机器人
  • bkchat使用说明

🏪 研发商店

• 浏览研发商店

• 流水线模板

• CI镜像

  • 构建并托管一个CI镜像
  • 发布一个CI镜像

• 流水线插件

  • 开发一个流水线插件

    • 插件开发指引
      • Java 插件开发指引
      • Python 插件开发指引
      • Golang 插件开发指引
      • NodeJS 插件开发指引
    • 插件开发规范
    • 插件配置规范
    • 插件输出规范
    • 插件错误码规范
    • 插件发布规范
    • 插件自定义UI
    • 插件UI组件使用示例
    • python sdk接口指引
    • 流水线插件开发案例
      • sendmsg-通用消息发送插件

  • 常用插件安装

  • 在 BKCI 里使用商店插件

🤝 一起共建 BKCI

• 文档共建

ℹ️ 参考信息

• REST API

  • 使用前必读
  • API使用示例
  • OPENAPI-项目模板资源
    • 批量更新流水线模板实例
    • 更新流水线模板
    • 批量实例化流水线模板
    • 创建流水线模板
    • 获取所有种类流水线模板列表
    • 获取流水线模板的实例列表
    • 获取流水线模板详情
    • 模版管理-获取模版列表
    • 删除流水线模板的版本
    • 删除流水线模板
  • OPENAPI-构建资源
    • 获取签名接口token
    • 查看签名任务状态信息
    • 获取签后IPA文件下载路径
    • 签名任务详情
  • OPENAPI-代码提交资源
    • 获取代码提交记录
  • OPENAPI-代码仓库资源
    • 编辑关联代码库
    • 关联代码库
    • 代码库列表
    • 删除代码库
  • OPENAPI-项目资源
    • 修改项目
    • 添加指定用户到指定项目用户组
    • 创建项目
    • 校验项目名称和项目英文名
    • 获取项目信息
    • 查询所有项目
  • OPENAPI-流水线资源
    • 更新流水线设置
    • 还原流水线编排
    • 更新流水线编排和设置
    • 编辑流水线编排
    • 导入新流水线, 包含流水线编排和设置
    • 批量获取流水线编排与配置
    • 流水线重命名
    • 复制流水线编排
    • 新建流水线编排
    • 获取流水线状态
    • 获取流水线编排
    • 获取项目的流水线列表
    • 删除流水线编排
  • OPENAPI-流水线分组
    • 更改标签
    • 更改分组
    • 添加标签
    • 添加分组
    • 获取所有分组信息
    • 删除标签
    • 删除分组
  • OPENAPI-迁移
    • 关联iam项目
    • 获取项目下pipelineId+自增id
  • OPENAPI-研发市场资源
    • 安装研发商店模板到项目
  • OPENAPI-构建日志资源
    • 获取更多日志
    • 根据构建ID获取初始化所有日志
    • 下载日志接口
    • 获取某行后的日志
  • OPENAPI-证书资源
    • 编辑凭据
    • 新增凭据
    • 获取凭据
    • 获取用户拥有对应权限凭据列表
    • 删除凭据
  • OPENAPI-callback资源
    • callback回调重试
    • 批量创建callback回调
    • 创建callback回调
    • callback回调执行历史记录
    • callback回调列表
    • callback回调移除
  • OPENAPI-构建资源
    • 启动构建
    • 获取构建中的变量值
    • 停止构建
    • 手动审核启动阶段
    • 重试构建-重试或者跳过失败插件
    • 操作暂停插件
    • 获取流水线手动启动参数
    • 获取流水线构建历史
    • 查看构建状态信息
    • 构建详情
  • OPENAPI-插件资源
    • 安装插件到项目
    • 根据插件代码获取插件统计信息
    • 根据插件代码获取使用的流水线详情
    • 根据插件代码获取插件详细信息
  • OPENAPI-构建产物资源
    • 获取用户下载链接
    • 根据元数据获取文件
  • OPENAPI-构建产物托管任务资源
    • 清理文件托管任务
    • 创建文件托管任务
    • 查询文件托管任务状态
  • OPENAPI-环境管理-构建机管理
    • 根据hashId获取项目节点列表(不校验权限)
    • 根据环境的hashId获取指定项目指定环境下节点列表(不校验权限)
    • 根据环境名称获取环境信息(不校验权限)
    • 根据hashId(多个)获取环境信息(不校验权限)
    • 获取指定构建机状态
    • 获取项目下第三方构建机列表
    • 获取用户有权限使用的服务器列表
    • 获取构建节点信息（扩展接口）
    • 获取构建节点信息（扩展接口）
    • 获取用户有权限使用的环境列表
  • QUALITY-质量红线相关
    • 更新拦截规则列表
    • 创建拦截规则
    • 获取拦截规则列表
    • 获取拦截记录
    • 删除拦截规则列表
  • WEBHOOK-代码事件触发
    • 获取流水线的webhook构建日志列表
    • 获取流水线的webhook列表

• 数据库设计文档

  • devops_ci_auth
  • devops_ci_sign
  • devops_ci_artifactory
  • devops_ci_repository
  • devops_ci_plugin
  • devops_ci_project
  • devops_ci_quality
  • devops_ci_store
  • devops_ci_log
  • devops_ci_dispatch
  • devops_ci_image
  • devops_ci_environment
  • devops_ci_op
  • devops_ci_notify
  • devops_ci_openapi
  • devops_ci_ticket
  • devops_ci_process
  • devops_ci_measure

• 预定义变量列表

  • GITHUB常量合集
  • GIT常量合集

• FAQS

  • 基本概念

  • 自检思路

  • 流水线

    • 流水线执行时相关问题

    • 使用常见问题

      • 流水线编排
      • 触发器
      • 构建机
      • 插件

    • 报错常见问题

      • 触发器
      • 构建机
      • 插件报错

  • 代码库

  • 页面报错

  • 服务异常

  • 机器重启

  • 环境管理

    • 使用常见问题
    • 报错常见问题

  • 代码检查

  • 制品库

  • 编译加速

  • 已知问题

  • 现有问题汇总

• 系统限制

  • 流水线复杂度限制

• 蓝鲸相关材料

  • 蓝鲸使用学习材料
  • 蓝鲸入门使用文档

---

• 返回 BKCI 官网