epigenesys/rails

Rails GitLab CI镜像文档

镜像概述

本镜像为GitLab CI/CD环境优化，基于官方Rails镜像构建，集成了持续集成流程所需的核心工具和依赖，旨在简化Rails应用在GitLab CI流水线中的配置与执行过程。镜像预配置了Ruby、Bundler、数据库客户端及构建工具，可直接用于测试、构建和部署阶段，减少CI环境准备时间。

核心功能与特性

• 预安装CI依赖：包含Ruby（匹配主流Rails版本）、Bundler、Node.js（用于资产编译）、数据库客户端（PostgreSQL、MySQL）及Git等工具
• CI流程适配：支持Rails应用的自动化测试（RSpec、Minitest）、资产编译（webpacker、sprockets）和依赖安装（bundle install）
• 多版本兼容：提供针对不同Rails版本（如6.x、7.x）的标签，适配各类Rails项目
• 轻量级优化：基于Alpine或Debian slim基础镜像，平衡功能与镜像体积，加速CI流水线启动

使用场景

• GitLab CI/CD流水线中的测试阶段：运行单元测试、集成测试、系统测试
• 构建阶段：编译前端资产（CSS/JS）、生成应用包
• 部署前验证：在部署至生产环境前执行预检查、数据库迁移测试

使用方法与配置说明

镜像获取

通过Docker Hub或私有仓库拉取镜像：

bash
docker pull [镜像仓库地址]/rails-gitlab-ci:[tag]
# 示例：拉取Rails 7.0版本
docker pull example/rails-gitlab-ci:7.0

本地测试

可通过以下命令在本地模拟CI环境：

bash
docker run -it --rm \
  -v $(pwd):/app \
  -e RAILS_ENV=test \
  -e DATABASE_URL=postgresql://user:pass@db:5432/test_db \
  example/rails-gitlab-ci:7.0 \
  bundle exec rspec

GitLab CI配置示例

在.gitlab-ci.yml中使用该镜像配置CI job：

yaml
stages:
  - test
  - build

test:
  stage: test
  image: example/rails-gitlab-ci:7.0
  services:
    - postgres:14
  variables:
    RAILS_ENV: test
    DATABASE_URL: postgresql://postgres:postgres@postgres:5432/test
    BUNDLE_PATH: vendor/bundle
  before_script:
    - bundle install --jobs $(nproc)
    - bundle exec rails db:create db:migrate
  script:
    - bundle exec rspec spec/
    - bundle exec rubocop

build:
  stage: build
  image: example/rails-gitlab-ci:7.0
  variables:
    RAILS_ENV: production
  script:
    - bundle install --without development test
    - bundle exec rails assets:precompile
  artifacts:
    paths:
      - public/assets/
      - tmp/cache/

环境变量说明

版本标签说明

镜像标签遵循[rails版本]-[基础镜像类型]格式，例如：

• 7.0-alpine：基于Alpine的Rails 7.0版本
• 6.1-slim：基于Debian slim的Rails 6.1版本
• latest：最新稳定Rails版本（默认Debian slim）

注意事项

• 数据库依赖：若使用MySQL/PostgreSQL，需在CI job中配置对应的services（如mysql:8.0、postgres:14）
• 缓存优化：建议在.gitlab-ci.yml中配置cache字段缓存vendor/bundle和node_modules，减少依赖安装时间
• 权限配置：镜像默认使用非root用户，挂载卷时需确保宿主目录权限允许容器访问