This guide will help you get started with a Ruby project on Semaphore. If you’re new to Semaphore please read our Guided tour first.
Table of contents:
- Hello world
- Ruby on Rails example
- Supported versions
- Dependency caching
- Environment variables
- Database configuration
- C-Extensions & system dependencies
- Browser testing
# .semaphore/semaphore.yml version: v1.0 name: Ruby example agent: machine: type: e1-standard-2 os_image: ubuntu1804 blocks: - name: Hello world task: jobs: - name: Run some code commands: - ruby -e 'puts "evol".reverse'
Ruby on Rails example project
Semaphore provides a tutorial and demo Rails application with a working CI pipeline that you can use to get started quickly:
Supported Ruby versions
You can also run Ruby projects by defining a [Docker-based Semaphore agent][docker-env].
On Linux, Semaphore uses rbenv to manage the supported Ruby versions. Any Ruby version listed in Ubuntu image reference is supported and can be used on Semaphore VM. The default version is set by the
.ruby-version file in your repository. If the
.ruby-version file is present, then you cannot force any other Ruby version for that directory. In that case you will need to modify or delete
.ruby-version in order to choose a different Ruby version.
You can also change the active Ruby version by calling
sem-version ruby followed by the desired Ruby version. Here's an example:
blocks: - name: Tests task: prologue: commands: - sem-version ruby 2.5.1 jobs: - name: Tests commands: - ruby --version
You can use Semaphores
cache command to store and load a gem bundle and configuration. In the following configuration example, we install dependencies and warm the cache in the first block, then use the cache in subsequent blocks.
#.semaphore/semaphore.yml version: v1.0 name: Example Ruby pipeline agent: machine: type: e1-standard-2 os_image: ubuntu1804 blocks: - name: Install dependencies task: jobs: - name: cache bundle commands: - checkout - cache restore gems-$SEMAPHORE_GIT_BRANCH-$(checksum Gemfile.lock),gems-$SEMAPHORE_GIT_BRANCH,gems-master - bundle install --deployment --path vendor/bundle - cache store gems-$SEMAPHORE_GIT_BRANCH-$(checksum Gemfile.lock) vendor/bundle - name: Tests task: prologue: commands: - checkout - cache restore gems-$SEMAPHORE_GIT_BRANCH-$(checksum Gemfile.lock) - bundle install --deployment --path vendor/bundle jobs: - name: Test all the things commands: - bundle exec rake test
If you need to clear cache for your project, launch a debug session and execute
cache clear or
cache delete <key>.
Semaphore doesn't set language specific environment variables like
RACK_ENV. You can set these at the task level.
blocks: - name: Tests task: env_vars: - name: RACK_ENV value: test jobs: - name: Everything commands: - bundle exec rake test
Rails 4.1+ supports using the
DATABASE_URL to configure a database. Older versions of Rails need to generate a
4.1+ - Using DATABASE_URL
Rails will read database configuration from
DATABASE_URL if set and
config/database.yml is empty. So, start a database with sem-service, set
DATABASE_URL, and clear the existing
config/database.yml. Here's an example block:
blocks: - name: Tests task: env_vars: # Matches the configuration used in sem-service - name: DATABASE_URL value: postgresql://postgres@localhost/test?encoding=utf8 - name: RAILS_ENV value: test jobs: - name: Test all the things commands: - checkout - sem-service start postgres # Clear existing config/database.yml - cat /dev/null > config/database.yml - bin/rails db:create - bin/rails test
Older Rails Versions
If your Rails version does not support
DATABASE_URL, then you can use a separate
config/database.yml for CI.
.semaphore along side your pipeline configurations. The configured
password match the connection info from sem-service.
# .semaphore/database.yml test: adapter: postgresql database: test pool: 5 username: postgres password: ~
RAILS_ENV and replace the existing
config/database.yml before running tests.
blocks: - name: Tests task: env_vars: - name: RAILS_ENV value: test jobs: - name: Test all the things commands: - checkout - sem-service start postgres # Use CI's database.yml - cp .semaphore/database.yml config/database.yml - bin/rails db:create - bin/rails test
C-Extensions & system dependencies
Projects may need system packages to install gems like
pg. Semaphore provides full
sudo access so you may install all required packages. Here's an example of installing the
blocks: - name: Tests task: prologue: commands: - sudo apt-get update && sudo apt-get install -y libpq-dev - gem install pg jobs: - name: Everything commands: - bundle exec rake test
Capybara is the recommended solution for browser tests in Ruby. The Firefox, Chrome, and Chrome Headless drivers work out of the box.
Refer to the Ubuntu image reference for details on preinstalled browsers and testing tools on Semaphore.