Rails7.2から、GitHub Actionsを使ったCIワークフローが標準で用意されるようになりました。
これにより、Railsアプリケーションの開発において、テストやセキュリティチェック、スタイルチェックが自動化され、開発体験が向上します。
このワークフローを見ていく中で、いくつかの学びがあったので、備忘録としてまとめてみました。
「CIで何しているかよくわからない」という方でも、この記事を通して「CIでこういうことをしているんだ」という理解を深めてもらえたら嬉しいです。
各ジョブを見ていく
1. scan_ruby（セキュリティチェックの自動化）
name: CI
on:
pull_request:
push:
branches: [ main ]
jobs:
scan_ruby:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: .ruby-version
bundler-cache: true
- name: Scan for common Rails security vulnerabilities using static analysis
run: bin/brakeman --no-pager
...
brakeman を使ってRailsアプリのセキュリティ脆弱性を静的解析しています。brakemanはRailsアプリ特有の脆弱性（例：SQLインジェクションやXSSなど）を検出するため、セキュリティチェックには非常に有用です。
--no-pagerオプションにより、CI上で結果を直接ターミナルに出力しています。
2. scan_js（JavaScript依存関係の監査）
...
scan_js:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: .ruby-version
bundler-cache: true
- name: Scan for security vulnerabilities in JavaScript dependencies
run: bin/importmap audit
...
importmap auditコマンドを使用して、npmレジストリにおけるJavaScriptの依存ライブラリのセキュリティ問題をチェックしています。
最新のRailsではImportmapを利用して依存関係を管理しており、このチェックを通すことでJavaScriptライブラリのセキュリティを担保しています。
3. lint（コードスタイルの維持）
...
lint:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: .ruby-version
bundler-cache: true
- name: Lint code for consistent style
run: bin/rubocop -f github
...
Rubocop を使用して、コードスタイルのチェックを行っています。特にチーム開発では、コードスタイルの統一が非常に重要なので、CIでの自動チェックがあることでレビューの効率化や品質担保が期待できます。
4. test（テストの自動実行）
...
test:
runs-on: ubuntu-latest
services:
mysql:
image: mysql
env:
MYSQL_ALLOW_EMPTY_PASSWORD: true
ports:
- 3306:3306
options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
# redis:
# image: redis
# ports:
# - 6379:6379
# options: --health-cmd "redis-cli ping" --health-interval 10s --health-timeout 5s --health-retries 5
steps:
- name: Install packages
run: sudo apt-get update && sudo apt-get install --no-install-recommends -y google-chrome-stable curl default-mysql-client libjemalloc2 libvips
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: .ruby-version
bundler-cache: true
- name: Run tests
env:
RAILS_ENV: test
DATABASE_URL: mysql2://127.0.0.1:3306
# REDIS_URL: redis://localhost:6379/0
run: bin/rails db:test:prepare test test:system
- name: Keep screenshots from failed system tests
uses: actions/upload-artifact@v4
if: failure()
with:
name: screenshots
path: ${{ github.workspace }}/tmp/screenshots
if-no-files-found: ignore
単体テスト・システムテストが自動実行されています。
Chromeブラウザをインストールしてシステムテストを自動で実行し、テストが失敗した場合にはスクリーンショットが自動的に保存されるような構造になっています。
CI上でシステムテストをどう動かすか、エラーの内容をどうわかりやすくするかといったところは課題になりやすい部分なので、こちらの内容を参考にしてみるのは良さそうです。
感想
Rails 7.2に標準で提供されているCIワークフローはシンプルかつ必要な要素がすべて揃っており、とても良い構成だと感じました。
自分たちが書いているワークフローでも同じようなことをやっているけど、結構無駄なこと書いているなという部分があったので、今回の内容を参考にブラッシュアップしていきたいです。
CI自動化で、より簡単により質の高いアプリケーションを開発していけるようにしていきましょう！