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.

GitHub integration

1. Visit https://app.saturnci.com
2. Click "Sign in with GitHub"
3. Connect your GitHub account with SaturnCI

Adding your repository to SaturnCI

1. In SaturnCI, go to GitHub Accounts > Add GitHubAccount
2. In SaturnCI, go to Repositories > Add Repository
3. Choose your repository
4. Follow the instructions below

To configure your Rails application for SaturnCI, 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

Next Steps

Once your configuration is pushed to GitHub, connect your repository to SaturnCI through the web interface. Your tests will run automatically on each push.