nasajon/yarn

Yarn + Git Docker 镜像文档

镜像概述

Yarn + Git 镜像为开发者提供了集成 Yarn 包管理器与 Git 版本控制系统的一站式 Docker 环境。该镜像基于轻量级 Linux 基础镜像构建，预装最新稳定版 Yarn 和 Git，旨在简化前端/Node.js 项目的依赖管理、代码版本控制及构建流程，确保开发、测试与部署环境的一致性。

核心功能和特性

工具集成

• Yarn：支持依赖安装（yarn install）、版本管理（yarn add/yarn remove）、项目构建（yarn build）等核心功能，兼容 Yarn 1.x/2.x/3.x 语法。
• Git：支持代码克隆（git clone）、分支管理（git checkout）、提交（git commit）、推送（git push）等完整版本控制操作。

环境优势

• 轻量级：基于 Alpine 或 Debian Slim 基础镜像，镜像体积小，启动速度快。
• 多平台支持：支持 amd64/arm64 等主流架构，适配本地开发与云环境。
• 即开即用：无需手动安装依赖，拉取镜像后可直接执行 Yarn/Git 命令。
• 环境隔离：容器化运行避免工具版本冲突，保护宿主环境纯净性。

使用场景和适用范围

开发环境

• 快速搭建临时开发环境，无需在本地安装 Yarn/Git。
• 多项目并行开发时，隔离不同项目的依赖与 Git 配置。

CI/CD 流程

• 作为 CI 管道的基础镜像，执行依赖安装（yarn install）、代码拉取（git clone）、版本标签创建（git tag）等步骤。
• 自动化构建流程中，统一依赖管理与代码版本控制工具链。

项目构建与部署

• 临时容器内完成项目构建（如 yarn build），输出产物挂载至宿主目录。
• 轻量级代码仓库操作（如克隆远程仓库、合并分支、生成补丁文件）。

使用方法和配置说明

镜像拉取

bash
# 拉取最新版本（默认标签 `latest`）
docker pull [镜像仓库地址]/yarn-git:latest

# 拉取指定版本（如 Yarn 1.22.21 + Git 2.40.1）
docker pull [镜像仓库地址]/yarn-git:yarn1.22.21-git2.40.1

基本使用示例

1. 验证工具版本

bash
# 查看 Yarn 版本
docker run --rm [镜像仓库地址]/yarn-git:latest yarn --version

# 查看 Git 版本
docker run --rm [镜像仓库地址]/yarn-git:latest git --version

2. 挂载本地项目执行依赖安装

将宿主机器的项目目录挂载至容器内，通过 Yarn 安装依赖：

bash
# 假设宿主项目路径为 ./my-project
docker run --rm -v $(pwd)/my-project:/app -w /app [镜像仓库地址]/yarn-git:latest yarn install

3. Git 配置与仓库操作

通过环境变量预设 Git 用户名/***，或在容器内直接配置：

bash
# 方式 1：通过环境变量预设 Git 身份（推荐）
docker run --rm -e GIT_USER_NAME="Your Name" -e GIT_USER_EMAIL="your@email.com" [镜像仓库地址]/yarn-git:latest git config --global --list

# 方式 2：容器内手动配置（临时生效）
docker run -it --rm [镜像仓库地址]/yarn-git:latest sh
# 进入容器后执行
git config --global user.name "Your Name"
git config --global user.email "your@email.com"

4. 克隆远程仓库并构建项目

bash
docker run --rm -v $(pwd)/output:/app [镜像仓库地址]/yarn-git:latest sh -c "
  git clone https://github.com/example/project.git /app && \
  cd /app && \
  yarn install && \
  yarn build
"

Docker 部署方案示例

docker run 命令示例

示例 1：本地项目依赖安装与构建

bash
docker run \
  --rm \  # 容器退出后自动删除
  -v $(pwd)/my-frontend:/app \  # 挂载宿主项目目录至容器 /app
  -w /app \  # 设置工作目录为 /app
  -e YARN_CACHE_FOLDER=/app/.yarn-cache \  # 指定 Yarn 缓存目录（避免重复下载）
  [镜像仓库地址]/yarn-git:latest \
  sh -c "yarn install && yarn build"  # 执行依赖安装与构建

示例 2：Git 仓库克隆与分支切换

bash
docker run \
  --rm \
  -v $(pwd)/repo:/repo \  # 挂载宿主目录存储克隆的仓库
  -e GIT_USER_NAME="CI Bot" \
  -e GIT_USER_EMAIL="ci@example.com" \
  [镜像仓库地址]/yarn-git:latest \
  sh -c "
    git clone https://github.com/example/repo.git /repo && \
    cd /repo && \
    git checkout feature/new-function && \
    git pull origin feature/new-function
  "

docker-compose 配置示例

创建 docker-compose.yml 文件，定义包含 Yarn + Git 环境的服务：

yaml
version: '3.8'

services:
  yarn-git-env:
    image: [镜像仓库地址]/yarn-git:latest
    volumes:
      - ./project:/app  # 挂载本地项目目录
      - yarn-cache:/root/.yarn/cache  # 持久化 Yarn 缓存（可选）
    environment:
      - GIT_USER_NAME=Dev Team
      - GIT_USER_EMAIL=dev@example.com
      - YARN_CACHE_FOLDER=/root/.yarn/cache  # 与缓存卷路径一致
    working_dir: /app
    command: sh -c "yarn install && yarn test"  # 默认执行依赖安装与测试

volumes:
  yarn-cache:  # 持久化卷，避免重复下载依赖

启动服务：

bash
docker-compose up

配置参数与环境变量

环境变量说明

自定义配置

如需修改 Git 或 Yarn 的全局配置，可通过挂载配置文件实现：

bash
# 挂载宿主 Git 配置文件至容器
docker run --rm -v ~/.gitconfig:/root/.gitconfig [镜像仓库地址]/yarn-git:latest git config --global --list

使用场景和适用范围补充说明

• 临时代码审查：快速克隆远程仓库，查看分支代码或生成差异补丁。
• 多版本测试：通过不同标签的镜像（如 yarn1.x-git2.x、yarn3.x-git2.x）测试项目在不同 Yarn 版本下的兼容性。
• 离线环境部署：提前在有网络环境拉取镜像并缓存依赖，再用于无网络环境的部署。