gitlab-org--gitlab-foss/doc/ci/examples/test-and-deploy-ruby-application-to-heroku.md

77 lines
2.5 KiB
Markdown
Raw Normal View History

2017-11-01 11:56:40 -04:00
# Test and Deploy a ruby application with GitLab CI/CD
2016-05-07 00:09:27 -04:00
This example will guide you how to run tests in your Ruby on Rails application and deploy it automatically as Heroku application.
2015-08-25 21:42:46 -04:00
You can checkout the example [source](https://gitlab.com/ayufan/ruby-getting-started) and check [CI status](https://gitlab.com/ayufan/ruby-getting-started/builds?scope=all).
2015-08-25 21:42:46 -04:00
2017-11-01 11:56:40 -04:00
## Configure the project
2015-08-25 21:42:46 -04:00
This is what the `.gitlab-ci.yml` file looks like for this project:
2017-11-01 11:56:40 -04:00
2015-08-25 21:42:46 -04:00
```yaml
test:
stage: test
2015-08-25 21:42:46 -04:00
script:
- apt-get update -qy
- apt-get install -y nodejs
- bundle install --path /cache
- bundle exec rake db:create RAILS_ENV=test
- bundle exec rake test
staging:
stage: deploy
2015-08-25 21:42:46 -04:00
script:
- gem install dpl
- dpl --provider=heroku --app=gitlab-ci-ruby-test-staging --api-key=$HEROKU_STAGING_API_KEY
only:
- master
production:
stage: deploy
2015-08-25 21:42:46 -04:00
script:
- gem install dpl
- dpl --provider=heroku --app=gitlab-ci-ruby-test-prod --api-key=$HEROKU_PRODUCTION_API_KEY
only:
- tags
```
This project has three jobs:
2016-05-07 00:09:27 -04:00
1. `test` - used to test Rails application,
2015-08-25 21:42:46 -04:00
2. `staging` - used to automatically deploy staging environment every push to `master` branch
3. `production` - used to automatically deploy production environment for every created tag
2015-08-25 21:42:46 -04:00
2017-11-01 11:56:40 -04:00
## Store API keys
You'll need to create two variables in your project's **Settings > CI/CD > Variables**:
2015-08-25 21:42:46 -04:00
1. `HEROKU_STAGING_API_KEY` - Heroku API key used to deploy staging app,
2. `HEROKU_PRODUCTION_API_KEY` - Heroku API key used to deploy production app.
Find your Heroku API key in [Manage Account](https://dashboard.heroku.com/account).
2017-11-01 11:56:40 -04:00
## Create Heroku application
2015-08-25 21:42:46 -04:00
For each of your environments, you'll need to create a new Heroku application.
You can do this through the [Dashboard](https://dashboard.heroku.com/).
2017-11-01 11:56:40 -04:00
## Create Runner
2015-08-25 21:42:46 -04:00
First install [Docker Engine](https://docs.docker.com/installation/).
To build this project you also need to have [GitLab Runner](https://about.gitlab.com/gitlab-ci/#gitlab-runner).
You can use public runners available on `gitlab.com`, but you can register your own:
2017-11-01 11:56:40 -04:00
2015-08-25 21:42:46 -04:00
```
2017-11-01 11:56:40 -04:00
gitlab-runner register \
2015-08-25 21:42:46 -04:00
--non-interactive \
--url "https://gitlab.com/" \
2015-08-25 21:42:46 -04:00
--registration-token "PROJECT_REGISTRATION_TOKEN" \
--description "ruby-2.2" \
2015-08-25 21:42:46 -04:00
--executor "docker" \
--docker-image ruby:2.2 \
2015-08-25 21:42:46 -04:00
--docker-postgres latest
```
2017-11-01 11:56:40 -04:00
With the command above, you create a Runner that uses [ruby:2.2](https://hub.docker.com/r/_/ruby/) image and uses [postgres](https://hub.docker.com/r/_/postgres/) database.
2015-08-25 21:42:46 -04:00
To access PostgreSQL database you need to connect to `host: postgres` as user `postgres` without password.