https://github.com/buildkite/rails-parallel-example
An example of how to run Rails CI and test steps in parallel with Buildkite
https://github.com/buildkite/rails-parallel-example
buildkite knapsack parallel pipeline rails rbenv
Last synced: 5 months ago
JSON representation
An example of how to run Rails CI and test steps in parallel with Buildkite
- Host: GitHub
- URL: https://github.com/buildkite/rails-parallel-example
- Owner: buildkite
- License: mit
- Created: 2016-02-17T03:58:28.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2023-04-05T12:46:53.000Z (over 2 years ago)
- Last Synced: 2025-05-05T19:18:13.263Z (5 months ago)
- Topics: buildkite, knapsack, parallel, pipeline, rails, rbenv
- Language: Ruby
- Homepage: https://github.com/buildkite/example-pipelines
- Size: 9.77 KB
- Stars: 7
- Watchers: 22
- Forks: 15
- Open Issues: 3
-
Metadata Files:
- Readme: Readme.md
- License: License.md
Awesome Lists containing this project
README
# Buildkite Rails Parallel Example
[](https://buildkite.com/new)
This repository is an example on how to easily run 20 parallel testing agents for a [Rails](https://rubyonrails.org/) application using [Buildkite](https://buildkite.com/), [rbenv](https://github.com/rbenv/rbenv) and [Knapsack](https://github.com/ArturT/knapsack).
This repository doesn't actually include a Rails sample application, but has the same CI scripts you would use for a production application.
Files to note:
* [.buildkite/hooks/environment](.buildkite/hooks/environment) - loads rbenv
* [.buildkite/pipeline.yml](.buildkite/pipeline.yml) - the pipeline config showing how to have parallel steps
* [scripts/ci/setup.sh](scripts/ci/setup.sh) - sets up the CI environment for each step
* [scripts/ci/parallel_specs.sh](scripts/ci/parallel_specs.sh) - runs the specs in parallel using Knapsack
## How does it work?
In the [pipeline configuration file](.buildkite/pipeline.yml) the `parallelism` property for the test step is set to 20. When a build, the step will appear 20 times in the pipeline, each with different environment variables exposed so you can divvy up your test suite accordingly. You can then run 20 agents (on the same machine, or distributed) to work on the 20 jobs in parallel.
```yml
steps:
- name: ":rspec:"
command: "scripts/ci/setup.sh && scripts/ci/parallel_specs.sh"
parallelism: 20
```
See the [parallelizing builds guide](https://buildkite.com/docs/guides/parallelizing-builds) for more information to create parallelized and distributed builds with Buildkite.
Consult the [Knapsack documentation](https://github.com/ArturT/knapsack) for configuring your database and dependent services to support running parallel steps on the one machine.
## Knapsack Pro
See [Knapsack Pro version of this example pipeline](https://github.com/KnapsackPro/buildkite-rails-parallel-example-with-knapsack_pro) for how to perform dynamic splits/allocation of test nodes.
## License
See [Licence.md](Licence.md) (MIT)