Skip to content

Latest commit

 

History

History
71 lines (47 loc) · 2.12 KB

README.md

File metadata and controls

71 lines (47 loc) · 2.12 KB
Raw

CI Runner

CI Runner is a Ruby library to help rerun test failures from your CI on your local machine without having to copy paste log output onto your terminal. CI Runner can rerun failures for the Minitest and RSpec test frameworks.

demo

⚙️ Installation

gem install ci_runner

Note

CI Runner is meant to be installed as a standalone software and not added inside an application's Gemfile.

Run CI Runner

🔓 Login

The first time you use CI Runner, you'll need to store a GitHub access_token. It's quick, I promise!

ci_runner help github_token

🏃‍♂️ Run !

Once you have stored your token, you can run CI Runner main's command: Both commands are identical, the second is just less typing 😄 .

ci_runner rerun
ci_runner

Note

You can also ask for help by typing ci_runner help rerun

❓ How does it work

CI Runner fetch GitHub Checks on your repository and download the associated logfile output on your laptop. It then parses the log output to find relevant information and finally execute a command to rerun exactly the same tests that failed on your CI.

😲 Test failures, Ruby version, specific Gemfile.

CI Runner aims to run tests on your local machine the same way as on CI. Therefore, CI runner detects the Ruby version used on CI as well as which set of dependencies (what Gemfile).

If a same Ruby version exists on your machine, CI runner will use that to rerun the test failures.

✅ Compatibility

CI Runner works with:

  • :octocat: Repositories hosted on GitHub
  • :octocat: GitHub CI
  • ⚫ Circle CI
  • 🪁 Buildkite
  • 🧪 Minitest
  • 🧪 RSpec

If your project uses a different CI, please open an Issue to let me know you are interested 😸.

📚 Wiki

The Wiki has more explanations on how CI Runner works and how you can configure it in case your projects uses a non standard test output.