danger-commit_lint 0.0.2 → 0.0.3

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 17d0cf1ee03d53740dba93d7473a038edef5004b
4
- data.tar.gz: 62c86199bef076c8b1843ff6135cda719a489945
3
+ metadata.gz: 79c1719195fcdbcc128f9c44cd0b4f8d22984721
4
+ data.tar.gz: 9c894bb9a99e856af8f3324293e373ab7ab5f844
5
5
  SHA512:
6
- metadata.gz: 6ecc81d9d7a04407a91766f1461ef7084c7c5595f4582799f7b69803892c5f5c7e3dc96a482fad6de0c028d2bd6bd6fd860164f4612831e8a9870cec19338a85
7
- data.tar.gz: 5978036983219fe4ab704ff39a25df63b32f78a09d943d00ecbf15e56f79402bd52e0e531e592d75c89591faec4078446445673f80276fd2f0a12deb28de85ac
6
+ metadata.gz: a5deaf8d09215b4f305a4f7c903af0a04c39c963d58ac8af00777182de2dd96a66ff7382c917b3fe4b7a01abd180117fd93fde7f601e1f82f6e220af9a60d283
7
+ data.tar.gz: 9b606ee00a9bb7a016d9a5a0d1f9c0a2b04c3055b16e0493920e03230e101ac3510f10b7d13c104ae1b440deca76f4c7bf9e4d80ffa5797c1c98f493d5269a0c
@@ -1,12 +1,18 @@
1
1
  language: ruby
2
- cache:
3
- directories:
4
- - bundle
2
+
3
+ cache: bundler
5
4
 
6
5
  rvm:
7
- - 2.0
8
- - 2.1.3
6
+ - 2.1
7
+ - 2.2
9
8
  - 2.3.1
9
+ - jruby-9
10
10
 
11
11
  script:
12
- - bundle exec rake
12
+ - bundle exec rake
13
+
14
+ notifications:
15
+ email: false
16
+ webhooks:
17
+ urls:
18
+ - https://uplink-app.herokuapp.com/travis_hooks
data/README.md CHANGED
@@ -3,8 +3,13 @@
3
3
  [![Build Status](https://travis-ci.org/jonallured/danger-commit_lint.svg?branch=master)](https://travis-ci.org/jonallured/danger-commit_lint)
4
4
 
5
5
  This is a [Danger Plugin][danger] that ensures nice and tidy commit messages.
6
+ The checks performed on each commit message are inspired by [Tim Pope's blog
7
+ post][tpope] on good commit messages, echoed by [git's own documentation][book]
8
+ on the subject.
6
9
 
7
- [danger]: https://github.com/danger/danger
10
+ [danger]: http://danger.systems/plugins/commit_lint.html
11
+ [tpope]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
12
+ [book]: https://www.git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#Commit-Guidelines
8
13
 
9
14
  ## Installation
10
15
 
data/Rakefile CHANGED
@@ -9,6 +9,7 @@ task default: [:spec, :rubocop, :spec_docs]
9
9
  desc 'Run RuboCop on the lib/specs directory'
10
10
  RuboCop::RakeTask.new(:rubocop) do |task|
11
11
  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
12
+ task.options = ['--display-cop-names']
12
13
  end
13
14
 
14
15
  desc 'Ensure that the plugin passes `danger plugins lint`'
@@ -1,3 +1,3 @@
1
1
  module CommitLint
2
- VERSION = '0.0.2'.freeze
2
+ VERSION = '0.0.3'.freeze
3
3
  end
@@ -1,6 +1,17 @@
1
1
  module Danger
2
2
  # Run each commit in the PR through a message linting.
3
3
  #
4
+ # Commit lint will check each commit in the PR to ensure the following is
5
+ # true:
6
+ #
7
+ # * Commit subject begins with a capital letter (`subject_cap`)
8
+ # * Commit subject is no longer than 50 characters (`subject_length`)
9
+ # * Commit subject does not end in a period (`subject_period`)
10
+ # * Commit subject and body are separated by an empty line (`empty_line`)
11
+ #
12
+ # By default, Commit Lint fails, but you can configure this behavior.
13
+ #
14
+ #
4
15
  # @example Lint all commits using defaults
5
16
  #
6
17
  # commit_lint.check
@@ -21,21 +32,22 @@ module Danger
21
32
 
22
33
  # Checks the commits with whatever config the user passes.
23
34
  #
24
- # @param [Hash] config
25
- # This hash can contain the following keys:
35
+ # Passing in a hash which contain the following keys:
36
+ #
37
+ # * `disable` - array of checks to skip
38
+ # * `fail` - array of checks to fail on
39
+ # * `warn` - array of checks to warn on
26
40
  #
27
- # * `disable` - array of checks to skip
28
- # * `fail` - array of checks to fail on
29
- # * `warn` - array of checks to warn on
41
+ # The current check types are:
30
42
  #
31
- # The current check types are:
43
+ # * `subject_cap`
44
+ # * `subject_length`
45
+ # * `subject_period`
46
+ # * `empty_line`
32
47
  #
33
- # * `subject_cap`
34
- # * `subject_length`
35
- # * `subject_period`
36
- # * `empty_line`
48
+ # Note: you can pass :all instead of an array to target all checks.
37
49
  #
38
- # Note: you can pass :all instead of an array to target all checks.
50
+ # @param [Hash] config
39
51
  #
40
52
  # @return [void]
41
53
  #
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: danger-commit_lint
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.2
4
+ version: 0.0.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Jon Allured
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2016-09-01 00:00:00.000000000 Z
11
+ date: 2016-10-07 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: danger
@@ -154,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
154
154
  version: '0'
155
155
  requirements: []
156
156
  rubyforge_project:
157
- rubygems_version: 2.6.6
157
+ rubygems_version: 2.6.7
158
158
  signing_key:
159
159
  specification_version: 4
160
160
  summary: A Danger Plugin that ensure commit messages are not too long, don't end in