debian-mirror-gitlab/doc/ci/examples/test-and-deploy-ruby-application-to-heroku.md

98 lines
3.2 KiB
Markdown
Raw Normal View History

2019-09-04 21:01:54 +05:30
---
2020-06-23 00:09:42 +05:30
stage: Verify
group: Continuous Integration
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers
2019-09-04 21:01:54 +05:30
type: tutorial
---
2019-07-07 11:18:12 +05:30
# Test and deploy a Ruby application with GitLab CI/CD
2018-03-17 18:26:18 +05:30
2019-09-04 21:01:54 +05:30
This example will guide you through how to run tests in your Ruby on Rails application and deploy it automatically as a Heroku application.
2015-09-25 12:07:36 +05:30
2019-09-04 21:01:54 +05:30
You can also view or fork the complete [example source](https://gitlab.com/ayufan/ruby-getting-started) and view the logs of its past [CI jobs](https://gitlab.com/ayufan/ruby-getting-started/-/jobs?scope=finished).
2015-09-25 12:07:36 +05:30
2018-03-17 18:26:18 +05:30
## Configure the project
2015-09-25 12:07:36 +05:30
This is what the `.gitlab-ci.yml` file looks like for this project:
2018-03-17 18:26:18 +05:30
2015-09-25 12:07:36 +05:30
```yaml
test:
2018-03-17 18:26:18 +05:30
stage: test
2015-09-25 12:07:36 +05:30
script:
2020-11-24 15:15:51 +05:30
- 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
2015-09-25 12:07:36 +05:30
staging:
2018-03-17 18:26:18 +05:30
stage: deploy
2015-09-25 12:07:36 +05:30
script:
2020-11-24 15:15:51 +05:30
- gem install dpl
- dpl --provider=heroku --app=gitlab-ci-ruby-test-staging --api-key=$HEROKU_STAGING_API_KEY
2015-09-25 12:07:36 +05:30
only:
2020-11-24 15:15:51 +05:30
- master
2015-09-25 12:07:36 +05:30
production:
2018-03-17 18:26:18 +05:30
stage: deploy
2015-09-25 12:07:36 +05:30
script:
2020-11-24 15:15:51 +05:30
- gem install dpl
- dpl --provider=heroku --app=gitlab-ci-ruby-test-prod --api-key=$HEROKU_PRODUCTION_API_KEY
2015-09-25 12:07:36 +05:30
only:
2020-11-24 15:15:51 +05:30
- tags
2015-09-25 12:07:36 +05:30
```
This project has three jobs:
2019-02-15 15:39:39 +05:30
- `test` - used to test Rails application.
- `staging` - used to automatically deploy staging environment every push to `master` branch.
- `production` - used to automatically deploy production environment for every created tag.
2015-09-25 12:07:36 +05:30
2018-03-17 18:26:18 +05:30
## Store API keys
2019-03-02 22:35:43 +05:30
You'll need to create two variables in your project's **Settings > CI/CD > Environment variables**:
2018-03-17 18:26:18 +05:30
2019-02-15 15:39:39 +05:30
- `HEROKU_STAGING_API_KEY` - Heroku API key used to deploy staging app.
- `HEROKU_PRODUCTION_API_KEY` - Heroku API key used to deploy production app.
2015-09-25 12:07:36 +05:30
Find your Heroku API key in [Manage Account](https://dashboard.heroku.com/account).
2018-03-17 18:26:18 +05:30
## Create Heroku application
2015-09-25 12:07:36 +05:30
For each of your environments, you'll need to create a new Heroku application.
2019-09-04 21:01:54 +05:30
You can do this through the [Heroku Dashboard](https://dashboard.heroku.com/).
2015-09-25 12:07:36 +05:30
2020-11-24 15:15:51 +05:30
## Create a runner
2018-03-17 18:26:18 +05:30
2015-09-25 12:07:36 +05:30
First install [Docker Engine](https://docs.docker.com/installation/).
2019-09-04 21:01:54 +05:30
2019-07-07 11:18:12 +05:30
To build this project you also need to have [GitLab Runner](https://docs.gitlab.com/runner/).
2020-05-24 23:13:21 +05:30
You can use public runners available on `gitlab.com` or register your own. Start by
creating a template configuration file in order to pass complex configuration:
```shell
cat > /tmp/test-config.template.toml << EOF
[[runners]]
[runners.docker]
[[runners.docker.services]]
name = "postgres:latest"
EOF
```
Finally, register the runner, passing the newly-created template configuration file:
2018-03-17 18:26:18 +05:30
2020-03-13 15:44:24 +05:30
```shell
2018-03-17 18:26:18 +05:30
gitlab-runner register \
2015-09-25 12:07:36 +05:30
--non-interactive \
2017-09-10 17:25:29 +05:30
--url "https://gitlab.com/" \
2015-09-25 12:07:36 +05:30
--registration-token "PROJECT_REGISTRATION_TOKEN" \
2020-03-13 15:44:24 +05:30
--description "ruby:2.6" \
2015-09-25 12:07:36 +05:30
--executor "docker" \
2020-05-24 23:13:21 +05:30
--template-config /tmp/test-config.template.toml \
--docker-image ruby:2.6
2015-09-25 12:07:36 +05:30
```
2020-11-24 15:15:51 +05:30
With the command above, you create a runner that uses the [`ruby:2.6`](https://hub.docker.com/_/ruby) image and uses a [PostgreSQL](https://hub.docker.com/_/postgres) database.
2015-09-25 12:07:36 +05:30
2019-09-04 21:01:54 +05:30
To access the PostgreSQL database, connect to `host: postgres` as user `postgres` with no password.