Setup and configuration

Prerequisites

SaturnCI only works with projects that use Ruby on Rails with the RSpec testing framework. In order to use SaturnCI, your project must be hosted on GitHub.

Sign up and connect your repository

1. Visit https://app.saturnci.com and sign up with GitHub
2. Install the SaturnCI GitHub App when prompted
3. Select your repository

Configure your application

Run the following command from your application's root directory:

rails app:template LOCATION=https://raw.githubusercontent.com/saturnci/saturnci-config-templates/main/rails/template.rb

This command will create a .saturnci directory in your project with all the necessary configuration files.

After running the template, commit the changes and push to GitHub:

git add .saturnci
git commit -m "Add SaturnCI configuration"
git push

Your tests will run automatically on each push.