README.md in face_control-0.8.6 vs README.md in face_control-0.9.0

- old
+ new

@@ -1,91 +1,77 @@ -# Face Control - [![Gem Version](https://img.shields.io/gem/v/face_control.svg)](https://rubygems.org/gems/face_control) [![Code Climate](https://img.shields.io/codeclimate/github/vassilevsky/face_control.svg)](https://codeclimate.com/github/vassilevsky/face_control/code) [![Vexor](https://ci.vexor.io/projects/126da196-c8e6-46f0-8bc7-b5f8f4b49732/status.svg)](https://ci.vexor.io/ui/projects/126da196-c8e6-46f0-8bc7-b5f8f4b49732/builds) [![Coveralls](https://img.shields.io/coveralls/vassilevsky/face_control.svg)](https://coveralls.io/github/vassilevsky/face_control) [![VersionEye](https://img.shields.io/versioneye/d/ruby/face_control.svg)](https://www.versioneye.com/ruby/face_control) +# Face Control + Run static analysis of pull requests in [Bitbucket Server][] (formerly Stash) and comment on problems in added lines. Currently supports [RuboCop][] and [CoffeeLint][] and also checks for TODOs and FIXMEs. Inspired by [Hound][]. ## Installation -```bash -gem install face_control -``` + gem install face_control -You also need to have CoffeeLint installed and available in `PATH`. +You also need to have CoffeeLint installed and available in PATH. ## Usage -```bash -face-control <project> <repository> <pull_request_id> -``` + face-control <project> <repository> <pull_request_id> -It's natural to run this on a continuous integration server (see “[Example](#example)” below). +It's natural to run this on a continuous integration server. +For example, here's a [Jenkins][] project setup: -If you don't want to receive RuboCop comments with certain severity level, -pass the severity in the `--skip-severity` option like so: +* Source Code Management + * Git + * Repositories + * Refspec: -```bash -face-control --skip-severity convention <project> <repository> <pull_request_id> -``` + +refs/pull-requests/*:refs/remotes/origin/pull-requests/* -Instead of `--skip-severity` you can use just `-S`. + (make Jenkins fetch otherwise ignored Stash-created branches) -You can also pass multiple severity levels as a comma-separated list: + * Branches to build + * Branch Specifier: -```bash -face-control -S convention,refactor <project> <repository> <pull_request_id> -``` + origin/pull-requests/*/merge -`face-control` uses the same configuration file (`~/.stashconfig.yml`) -as the official [Bitbucket Server Command Line Tools][] -to connect to your Stash instance. + (merge results of open non-conflicting pull requests) -## Example +* Build + * Execute shell + * Command -Here's a [Jenkins][] project setup as an example: + export PULL_REQUEST_ID=`echo $GIT_BRANCH | cut -d / -f 3` -_Source Code Management → Git → Repositories → Refspec:_ + gem install rubocop face_control + npm install -g coffeelint -``` -+refs/pull-requests/*:refs/remotes/origin/pull-requests/* -``` + face-control <project> <repository> $PULL_REQUEST_ID -It makes Jenkins fetch otherwise ignored Stash-created branches. +If you don't want to receive RuboCop comments with certain severity level, +pass the severity in the `--skip-severity` option like so: -_Source Code Management → Git → Branches to build → Branch Specifier:_ + face-control --skip-severity convention <project> <repository> <pull_request_id> -``` -origin/pull-requests/*/merge -``` +You can use just `-S`. +You can also pass multiple severity levels as a comma-separated list: -Merge results of open non-conflicting pull requests. + face-control -S convention,refactor <project> <repository> <pull_request_id> -_Build → Execute shell → Command:_ +`face-control` uses the same configuration file (`~/.stashconfig.yml`) +as the official [Bitbucket Server Command Line Tools][] +to connect to your Stash instance. -```bash -export PULL_REQUEST_ID=`echo $GIT_BRANCH | cut -d / -f 3` - -gem install rubocop face_control -npm install -g coffeelint - -face-control <project> <repository> $PULL_REQUEST_ID -``` - ## Etymology -[Face control][] in Wikipedia. - -[![Sponsored by FunBox](https://funbox.ru/badges/sponsored_by_funbox_centered.svg)](https://funbox.ru) +[Face control][] in Wikipedia [Hound]: https://houndci.com [Bitbucket Server]: https://www.atlassian.com/software/bitbucket/server [Bitbucket Server Command Line Tools]: https://bitbucket.org/atlassian/bitbucket-server-cli [RuboCop]: http://batsov.com/rubocop/