Ruby Setup Action 使用教程

1. 项目介绍

ruby/setup-ruby 是一个 GitHub Action，用于下载预构建的 Ruby 并将其添加到 PATH 中。它非常高效，通常只需要大约 5 秒的时间来下载、解压并添加指定的 Ruby 版本到 PATH。这个 Action 支持多种 Ruby 解释器版本，包括 MRI、JRuby 和 TruffleRuby，并且可以在多个操作系统上运行，如 Ubuntu、macOS 和 Windows。

2. 项目快速启动

2.1 安装 Ruby

首先，确保你已经安装了 Ruby。你可以通过以下命令检查是否已经安装了 Ruby：

ruby -v

如果没有安装，你可以使用以下命令通过包管理器安装 Ruby：

# 对于 Debian/Ubuntu
sudo apt-get install ruby-full

# 对于 CentOS/Fedora/RHEL
sudo yum install ruby

# 对于 macOS (使用 Homebrew)
brew install ruby

2.2 配置 GitHub Action

在你的 GitHub 仓库中，创建一个 .github/workflows 目录，并在其中创建一个 .yml 文件，例如 ruby-ci.yml。在这个文件中，添加以下内容：

name: Ruby CI

on: [push, pull_request]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - uses: ruby/setup-ruby@v1
      with:
        ruby-version: '3.3' # 指定你需要的 Ruby 版本
        bundler-cache: true # 自动运行 'bundle install' 并缓存安装的 gems
    - run: bundle exec rake

2.3 运行 GitHub Action

提交并推送你的更改，GitHub Action 将会自动运行并安装指定的 Ruby 版本，然后执行 bundle exec rake 命令。

3. 应用案例和最佳实践

3.1 多版本 Ruby 测试

在开发过程中，你可能需要测试你的代码在不同版本的 Ruby 上是否兼容。ruby/setup-ruby 支持矩阵测试，你可以在同一个工作流中测试多个 Ruby 版本：

name: Ruby CI

on: [push, pull_request]

jobs:
  test:
    strategy:
      fail-fast: false
      matrix:
        ruby: ['2.7', '3.0', '3.1', '3.2', '3.3', 'head', 'jruby', 'jruby-head', 'truffleruby', 'truffleruby-head']
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - uses: ruby/setup-ruby@v1
      with:
        ruby-version: ${{ matrix.ruby }}
        bundler-cache: true
    - run: bundle exec rake

3.2 缓存 Gem 安装

通过设置 bundler-cache: true，ruby/setup-ruby 会自动运行 bundle install 并缓存安装的 gems，从而加快 CI 的速度。

4. 典型生态项目

4.1 Ruby on Rails

Ruby on Rails 是一个流行的 Web 应用框架，使用 ruby/setup-ruby 可以轻松地在 CI 环境中配置和测试 Rails 项目。

4.2 Jekyll

Jekyll 是一个静态站点生成器，使用 ruby/setup-ruby 可以方便地配置和测试 Jekyll 项目。

4.3 Sinatra

Sinatra 是一个轻量级的 Web 应用框架，使用 ruby/setup-ruby 可以快速配置和测试 Sinatra 项目。

通过以上步骤，你可以轻松地在 GitHub Actions 中配置和使用 Ruby，并利用 ruby/setup-ruby 提供的功能来加速你的 CI 流程。