README.md in lois-0.1.0 vs README.md in lois-0.1.1
- old
+ new
@@ -1,8 +1,8 @@
# Lois [![CircleCI](https://circleci.com/gh/ketiko/lois.svg?style=svg)](https://circleci.com/gh/ketiko/lois)
-Lois reports statuses of CI results to Github Pull Request Statuses.
+Lois reports statuses of CI results to GitHub Pull Request Statuses.
## Installation
Add this line to your application's Gemfile:
@@ -30,42 +30,56 @@
lois reek -g, --github-credentials=GITHUB_CREDENTIALS # Run reek
lois rubocop -g, --github-credentials=GITHUB_CREDENTIALS # Run Rubocop
lois simplecov -g, --github-credentials=GITHUB_CREDENTIALS # Run simplecov
```
-Lois has commands to run and report ruby quality metrics to Github PR Statuses. All it requires is
-a github basic auth credentials for a user to report the statuses. The user needs write access to the repo to post
+Lois has commands to run and report ruby quality metrics to GitHub PR Statuses. All it requires is
+a GitHub basic auth credentials for a user to report the statuses. The user needs write access to the repo to post
PR status updates.
See [https://developer.github.com/v3/auth/#basic-authentication](https://developer.github.com/v3/auth/#basic-authentication).
We recommend using oauth tokens and not your password.
Currently we only support reporting through [CircleCI](https://circleci.com/), but PRs for additional continuous integration systems are welcome.
Lois will output all the results of the checks to a `lois` directory. You can add this to your artifact path to view the html representation of the results later.
+##### CircleCI 2.0
A sample `.circleci/config.yml` would look like:
```
- run:
name: Bundler-Audit
- command: bin/lois bundler-audit -g $GITHUB_CREDENTIALS
+ command: bundle exec lois bundler-audit -g $GITHUB_CREDENTIALS
- run:
name: Brakeman
- command: bin/lois brakeman -g $GITHUB_CREDENTIALS
+ command: bundle exec lois brakeman -g $GITHUB_CREDENTIALS
- run:
name: Rubocop
- command: bin/lois rubocop -g $GITHUB_CREDENTIALS
+ command: bundle exec lois rubocop -g $GITHUB_CREDENTIALS
- run:
name: Reek
- command: bin/lois reek -g $GITHUB_CREDENTIALS
+ command: bundle exec lois reek -g $GITHUB_CREDENTIALS
- store_artifacts:
path: lois
destination: lois
+```
+
+##### CircleCI 1.0
+A sample `circle.yml` would look like:
+```
+test:
+ pre:
+ - bundle exec lois bundler-audit -g $GITHUB_CREDENTIALS
+ - bundle exec lois brakeman -g $GITHUB_CREDENTIALS
+ - bundle exec lois rubocop -g $GITHUB_CREDENTIALS
+ - bundle exec lois reek -g $GITHUB_CREDENTIALS
+ post:
+ - cp -r lois $CIRCLE_ARTIFACTS/
```
### SimpleCov
To get SimpleCov output you must have an `at_exit` hook. A sample SimpleCov setup looks like: