Bit DevOps Docker镜像文档

镜像概述

该Docker镜像包含Bit CLI的夜间构建版本及专用脚本，旨在简化Bit相关的开发环境配置和CI/CD自动化流程。支持多平台部署，适用于本地开发环境和主流CI/CD平台（GitHub Actions、Azure DevOps、GitLab CI/CD等）。

快速开始

前提条件

1. 安装Docker Desktop
2. 安装VSCode扩展：Docker Extension
3. 安装VSCode扩展：Dev Containers Extension

使用Docker镜像

拉取镜像

bash
docker pull bitsrc/nightly:latest

启动容器并连接VSCode

启动容器后，可通过VSCode的Docker扩展附加到容器进行开发。

有关容器内开发的最佳实践，请参考：在容器内开发

在CI/CD中使用

GitHub Actions

yaml
# @文件 github-action.yml

name: 构建

on:
  workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest
    container:
      image: bitsrc/nightly:latest
    env:
      HOME: /home/bituser
    steps:
      - name: 初始化工作区
        run: |
          bit -v
        displayName: '初始化工作区'

Azure DevOps Pipelines

yaml
# @文件 azure-pipelines.yml

trigger: none

pr: none

jobs:
- job: build
  displayName: 构建
  pool:
    vmImage: 'ubuntu-latest'
  container:
    image: bitsrc/nightly:latest
  steps:
  - script: |
      bit -v
    displayName: '检查bit版本'

GitLab CI/CD

yaml
# @文件 .gitlab-ci.yml

image: bitsrc/nightly:latest
  
build-job:
  stage: build
  script: 
    - |
      echo "bit版本: $(bit -v)"

除预安装的最新Docker版本外，镜像中还包含专用于GitLab的脚本：

• gitlab.bit.init
• gitlab.bit.verify
• gitlab.bit.commit-bitmap
• gitlab.bi***rge-request
• gitlab.bit.tag-export
• gitlab.bit.branch-lane
• gitlab.bit.dependency-update

使用示例：

yaml
# @文件 .gitlab-ci.yml

image: bitsrc/nightly:latest

variables:
  BIT_CONFIG_ACCESS_TOKEN: "bit_config_access_token"
  GIT_USER_NAME: "git用户名"
  GIT_USER_*** "git用户***"

build-job:
  stage: build
  script: 
    - |      
      gitlab.bit.init
      gitlab.bit.verify
  rules:
     - if: '$CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_BRANCH == "main"'

实用工具脚本

CheckServer

checkserver命令用于测试bit start和bit run <app-name>命令。

bash
checkserver <服务器URL>

可指定最大超时时间和检查频率：

bash
cd my-workspace
bit start &  # 在后台运行开发服务器
checkserver http://localhost:3000 600 5  # 最大超时：600秒，检查频率：5秒

注意：必须使用&在后台运行开发服务器，然后再执行checkserver命令。

BareScope

barescope命令用于在CI环境中创建Bare Scope。

bash
barescope <作用域名称> <工作区目录>

示例：

bash
barescope my-scope my-workspace
cd my-workspace
bit scope rename org.scope-name my-scope --refactor
bit link
bit compile
bit tag --message "CI标记"
bit export

EngineStrict

enginestrict命令用于安装workspace.jsonc中定义的Bit引擎版本。

jsonc
"teambit.harmony/bit": {
  "engine": "0.2.3",
  "engineStrict": false // 当引擎版本与工作区不一致时，警告或报错
},

注意：使用bvm list --remote可列出可用的Bit版本。

贡献指南

如需推送新镜像到Docker Hub，可按以下步骤操作：

本地构建并发布镜像

sh
docker buildx build --platform linux/amd64,linux/arm64 -t bitsrc/nightly:latest . --push

注意：如需本地运行构建的镜像，使用单一平台（linux/amd64或linux/arm64）并将--push替换为--load参数。

NODE_HEAP_SIZE（可选，默认4096）

指定镜像的自定义堆大小：

• 4096（默认）
• 8192

sh
docker buildx build --platform linux/amd64,linux/arm64 --build-arg NIGHTLY=true --build-arg NODE_HEAP_SIZE=8192 -t bitsrc/nightly:latest . --push

使用GitHub Action

可使用本仓库中指定的GitHub Action发布镜像的新版本。