algolia/docs-docker-image

Algolia文档CircleCI Docker镜像

概述

该Docker镜像由Algolia文档团队开发，主要用于在CircleCI平台上执行持续集成（CI）和持续部署（CD）工作流。镜像基于CircleCI官方的cimg/ruby:2.7.6镜像构建，并预先集成了文档开发和部署所需的关键依赖工具。

核心功能与特性

基础环境

• 底层镜像：基于CircleCI的cimg/ruby:2.7.6，提供Ruby 2.7.6运行环境及相关基础工具

预安装依赖

• Node.js：用于文档构建、前端资源处理等JavaScript相关任务
• Vale：文档风格和语法检查工具，确保文档质量一致性
• AWS CLI：Amazon Web Services命令行工具，支持文档部署到AWS服务

使用场景

• Algolia文档团队的日常CI/CD流程，包括文档构建、语法检查、自动化测试和部署
• 需要Ruby 2.7.6环境且依赖Node.js、Vale或AWS CLI的文档相关自动化任务

使用方法

在CircleCI中配置

在CircleCI配置文件（.circleci/config.yml）中指定此镜像作为执行环境：

yaml
version: 2.1
jobs:
  documentation-workflow:
    docker:
      - image: [镜像名称]  # 替换为实际镜像名称/路径
    steps:
      - checkout
      # 示例步骤：文档构建
      - run: bundle install
      - run: npm install
      # 示例步骤：文档风格检查
      - run: vale docs/
      # 示例步骤：部署到AWS
      - run: aws s3 sync docs/build s3://[bucket-name]/docs --delete

注：实际使用时需将[镜像名称]替换为该Docker镜像的具体标识（如Docker Hub或私有仓库地址），将[bucket-name]替换为实际AWS S3存储桶名称。

本地测试（可选）

如需在本地测试该镜像，可通过以下命令运行：

bash
docker run -it --rm [镜像名称] /bin/bash

进入容器后，可验证依赖是否正确安装：

bash
ruby --version      # 应显示2.7.6版本
node --version      # 验证Node.js安装
vale --version      # 验证Vale安装
aws --version       # 验证AWS CLI安装