pronto 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 195c3906036b06ef0b74e616670e720383e55b04
-  data.tar.gz: 0029eaab3605b1ef44a70b27bab5b3bfbc88f237
+  metadata.gz: 7f045d7e7257a5032c6d66fe14aafc3b601a2c46
+  data.tar.gz: f4c937f5b374da8ea1cac828bd7e85ac3923fb53
 SHA512:
-  metadata.gz: 31ed61645876409ba9ddcb7baf707b4c645f5c81636b791b23a4c1b3584a907ca8f83737ac85345e0c893bd0c61879b91746d53fe0faa6ea882b0e551863ae4e
-  data.tar.gz: 75c37c34cc8871a7f9dcd769c711a0ce791922a904855f8a1ef204e0e0753f1822986020c5c3e4c17c143f14fc540f2468ac4352a7724092f65f8afa74e0dbb1
+  metadata.gz: 77ae86e2fdfa6c85dabedfee311ac604104d8bfec7194d375b6c6d92306178aaa7bd0c5a4bdf46fd5e8c41b1a53153bc5c0abdfa7c0fec323e4fd533557fca59
+  data.tar.gz: 849e03f87e173b568dcd716d4701118a3c7461cae70c815de411b10859a6a31adf98658b74c2e713520d8304a231cd00ce505e6cf23f06de6bc1eb3e9d9f6763

data/CHANGELOG.md

@@ -6,11 +6,17 @@
 ### Changes
 ### Bugs fixed
 
+## 0.5.3
+
+### Bugs fixed
+
+* Remove pronto.gif from gem, accidently included since `0.5.0`.
+
 ## 0.5.2
 
 ### Bugs fixed
 
-* GithubPullRequestFormatter was working incorrectly when `PULL_REQUEST_ID` is not specified. Introduced in `0.5.1`
+* GithubPullRequestFormatter was working incorrectly when `PULL_REQUEST_ID` is not specified. Introduced in `0.5.1`.
 
 ## 0.5.1
 

data/README.md

@@ -6,19 +6,46 @@
 [![Dependency Status](https://gemnasium.com/mmozuras/pronto.png)](https://gemnasium.com/mmozuras/pronto)
 [![Inline docs](http://inch-ci.org/github/mmozuras/pronto.png)](http://inch-ci.org/github/mmozuras/pronto)
 
-Pronto runs analysis quickly by checking only the relevant changes. Created to
+**Pronto** runs analysis quickly by checking only the relevant changes. Created to
 be used on [pull requests](#github-integration), but also works [locally](#local-changes) and integrates with [GitLab](#gitlab-integration).
 Perfect if want to find out quickly if branch introduces changes that conform
 to your [styleguide](https://github.com/mmozuras/pronto-rubocop), [are DRY](https://github.com/mmozuras/pronto-flay), [don't introduce security holes](https://github.com/mmozuras/pronto-brakeman) and [more](#runners).
 
 ![Pronto demo](pronto.gif "")
 
+* [Installation](#installation)
 * [Usage](#usage)
     * [Local Changes](#local-changes)
     * [GitHub Integration](#github-integration)
     * [GitLab Integration](#gitlab-integration)
 * [Configuration](#configuration)
 * [Runners](#runners)
+* [Changelog](#changelog)
+* [Copyright](#copyright)
+
+## Installation
+
+**Pronto**'s installation is standard for a Ruby gem:
+
+```sh
+$ gem install pronto
+```
+
+You'll also want to install some [runners](#runners) to go along with the main gem:
+
+```sh
+$ gem install pronto-rubocop
+$ gem install pronto-flay
+```
+
+If you'd rather install Pronto using `bundler`, you don't need to require it,
+unless you're gonna run it from Ruby (via Rake task, for example):
+
+```ruby
+gem 'pronto'
+gem 'pronto-rubocop', require: false
+gem 'pronto-flay', require: false
+```
 
 ## Usage
 
@@ -26,13 +53,9 @@ Pronto runs the checks on a diff between the current HEAD and the provided commi
 
 ### Local Changes
 
-You can run Pronto locally. First, install Pronto and the runners you want to use:
-```bash
-gem install pronto
-gem install pronto-rubocop
-```
-Then navigate to the repository you want to run Pronto on, and:
-```bash
+Navigate to the repository you want to run Pronto on, and:
+
+```sh
 git checkout feature/branch
 
 # Analyze diff of committed changes on current branch and master:
@@ -63,30 +86,24 @@ You can run Pronto as a step of your CI builds and get the results as comments
 on GitHub commits using `GithubFormatter` or `GithubPullRequestFormatter`.
 
 Add Pronto runners you want to use to your Gemfile:
-```ruby
-gem 'pronto'
-gem 'pronto-rubocop', require: false
-gem 'pronto-scss', require: false
-```
-or gemspec file:
-```ruby
-s.add_development_dependency 'pronto'
-s.add_development_dependency 'pronto-rubocop'
-s.add_development_dependency 'pronto-scss'
-```
+
 Set the GITHUB_ACCESS_TOKEN environment variable or value in `.pronto.yml` to
 [OAuth token](https://help.github.com/articles/creating-an-access-token-for-command-line-use) that has access to the repository.
 
 Then just run it:
-```bash
-GITHUB_ACCESS_TOKEN=token pronto run -f github -c origin/master
+
+```sh
+$ GITHUB_ACCESS_TOKEN=token pronto run -f github -c origin/master
 ```
+
 or, if you want comments to appear on pull request diff, instead of commit:
-```bash
-GITHUB_ACCESS_TOKEN=token PULL_REQUEST_ID=id pronto run -f github_pr -c origin/master
+
+```sh
+$ GITHUB_ACCESS_TOKEN=token PULL_REQUEST_ID=id pronto run -f github_pr -c origin/master
 ```
 
 As an alternative, you can also set up a rake task:
+
 ```ruby
 Pronto.gem_names.each { |gem_name| require "pronto/#{gem_name}" }
 
@@ -101,19 +118,6 @@ on GitLab commits using `GitlabFormatter`.
 
 **note: this requires at least GitLab v7.5.0**
 
-Add Pronto runners you want to use to your Gemfile:
-```ruby
-gem 'pronto'
-gem 'pronto-rubocop', require: false
-gem 'pronto-scss', require: false
-```
-or gemspec file:
-```ruby
-s.add_development_dependency 'pronto'
-s.add_development_dependency 'pronto-rubocop'
-s.add_development_dependency 'pronto-scss'
-```
-
 Set the `GITLAB_API_ENDPOINT` environment variable or value in `.pronto.yml` to
 your API endpoint URL. If you are using Gitlab.com's hosted service your
 endpoint will be `https://gitlab.com/api/v3`.
@@ -121,11 +125,13 @@ Set the `GITLAB_API_PRIVATE_TOKEN` environment variable or value in `.pronto.yml
 to your Gitlab private token which you can find in your account settings.
 
 Then just run it:
-```bash
-GITLAB_API_ENDPOINT="https://gitlab.com/api/v3" GITLAB_API_PRIVATE_TOKEN=token pronto run -f gitlab -c origin/master
+
+```sh
+$ GITLAB_API_ENDPOINT="https://gitlab.com/api/v3" GITLAB_API_PRIVATE_TOKEN=token pronto run -f gitlab -c origin/master
 ```
 
 As an alternative, you can also set up a rake task:
+
 ```ruby
 Pronto.gem_names.each { |gem_name| require "pronto/#{gem_name}" }
 
@@ -178,3 +184,11 @@ Currently available:
 * [pronto-rubocop](https://github.com/mmozuras/pronto-rubocop)
 * [pronto-scss](https://github.com/mmozuras/pronto-scss)
 * [pronto-spell](https://github.com/mmozuras/pronto-spell)
+
+## Changelog
+
+**Pronto**'s changelog is available [here](CHANGELOG.md).
+
+## Copyright
+
+Copyright (c) 2013-2015 Mindaugas Mozūras. See [LICENSE](LICENSE) for further details.

data/lib/pronto/version.rb

@@ -1,3 +1,3 @@
 module Pronto
-  VERSION = '0.5.2'
+  VERSION = '0.5.3'
 end

data/pronto.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |s|
     spec/.*
     |Gemfile
     |Rakefile
+    |pronto.gif
     |\.rspec
     |\.gitignore
     |\.rubocop.yml

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pronto
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - Mindaugas Mozūras
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-10 00:00:00.000000000 Z
+date: 2015-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rugged
@@ -193,7 +193,6 @@ files:
 - lib/pronto/runners.rb
 - lib/pronto/version.rb
 - pronto.gemspec
-- pronto.gif
 homepage: http://github.com/mmozuras/pronto
 licenses:
 - MIT