Skip to content
play

GitHub Action

setup-rails

v1 Latest version

setup-rails

play

setup-rails

Set up Rails CI using GitHub Actions

Installation

Copy and paste the following snippet into your .yml file.

              

- name: setup-rails

uses: setup-rails/setup-rails@v1

Learn more about this action in setup-rails/setup-rails

Choose a version

setup-rails

This is a re-usable GitHub Actions workflow based on the post Building a Rails CI pipeline with GitHub Actions by Matt Swanson.

Blog Post: A GitHub Actions Rails CI Workflow in 5 lines

To use it, create a file in your repo at .github/workflows/verify.yml containing:

name: Verify
on: [push, pull_request]

jobs:
  verify:
    uses: setup-rails/setup-rails/.github/workflows/verify.yml@v1 # use @main for latest updates
    # uncomment to enable options:
    #
    # with:
    #   brakeman: true
    #   bundler-audit: true
    #   rspec: true
    #   rubocop: true
    #   standard: true

Alternatively, you can install with RailsBytes:

rails app:template LOCATION="https://railsbytes.com/script/VMys8A"

You may also need to update Gemfile.lock by running:

bundle lock --add-platform x86_64-linux

Here is an example app which uses this workflow.

Current Limitations

  • Assumes postgres, no support for mysql or other databases
  • Assumes yarn or bun, no support for npm