kpn-style 0.1.2 → 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +5 -5
- data/README.md +47 -0
- data/kpn_style.gemspec +2 -2
- data/lib/kpn/style/version.rb +1 -1
- data/ruby-2.4.yml +1 -1
- metadata +4 -5
- data/RELEASING.md +0 -16
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
|
-
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: 77ddda7401805a90cdc67abd6c44fca3bef2c9b7a05fea8459c71cfa6c570f98
|
|
4
|
+
data.tar.gz: 0b16e758963051e536df4e50d65249eeb38086250a1b8ba93ab84d697cea5be3
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a7b0ba010f74971634f40ab14d2079d9adf34d50ebee65d209e235847d319eebd3304e44b2b26ffa74f3151545bb03e007797d5c28b9f34f3eb02f08fb7a92f2
|
|
7
|
+
data.tar.gz: 87181780ca1431e97ce08f4d9fdbb040cd99d8a70bea9c869d08d6e40d35e8dc28ed866d7866ed8e77d905753d691534f33c42c2a30f9358b007578c1971a53f
|
data/README.md
CHANGED
|
@@ -46,6 +46,53 @@ Now, run:
|
|
|
46
46
|
|
|
47
47
|
```bash
|
|
48
48
|
$ bundle exec rubocop
|
|
49
|
+
|
|
50
|
+
or
|
|
51
|
+
|
|
52
|
+
$ rake rubocop
|
|
49
53
|
```
|
|
50
54
|
|
|
51
55
|
You do not need to include rubocop directly in your application's dependencies. kpn-style will include a specific version of `rubocop` and `rubocop-rspec` that is shared across all projects.
|
|
56
|
+
|
|
57
|
+
## Style overrides
|
|
58
|
+
|
|
59
|
+
Sometimes you need to override style rules. RuboCop have a nice inheritance hierachy so you can override the default settings.
|
|
60
|
+
The hierachy is:
|
|
61
|
+
|
|
62
|
+
```
|
|
63
|
+
inherit_gem -> inherit_from -> local rules
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
For example:
|
|
67
|
+
|
|
68
|
+
```yaml
|
|
69
|
+
inherit_gem:
|
|
70
|
+
kpn-style:
|
|
71
|
+
- ruby-2.1.yml
|
|
72
|
+
|
|
73
|
+
inherit_from: .rubocop_todo.yml
|
|
74
|
+
|
|
75
|
+
AllCops:
|
|
76
|
+
Exclude:
|
|
77
|
+
- exclude/file.rb
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
## Update gem
|
|
81
|
+
|
|
82
|
+
1. Update the ruby-2.X.yml file
|
|
83
|
+
2. Update the version parameter `spec.version` in the `kpn_style.gemspec`
|
|
84
|
+
3. Tag the release: `git tag VERSION`
|
|
85
|
+
4. Push changes: `git push --tags`
|
|
86
|
+
5. Update the release notes on GitHub.com
|
|
87
|
+
6. Build and publish:
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
gem build kpn_style.gemspec
|
|
91
|
+
gem push kpn-style-x.x.x.gem
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
To push gems to rubygems.org you can use a `~/.gem/credentials` with the `rubygems_api_key`. You can find a small how to on the Profile edit page https://rubygems.org/profile/edit in the section `API ACCESS`.
|
|
95
|
+
|
|
96
|
+
### Special thanks
|
|
97
|
+
|
|
98
|
+
A special thanks to https://github.com/percy/percy-style/ for the idea and template of this Gem.
|
data/kpn_style.gemspec
CHANGED
|
@@ -3,11 +3,11 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
|
|
3
3
|
|
|
4
4
|
Gem::Specification.new do |spec|
|
|
5
5
|
spec.name = 'kpn-style'
|
|
6
|
-
spec.version = '0.1.
|
|
6
|
+
spec.version = '0.1.3'
|
|
7
7
|
spec.authors = ['kpn']
|
|
8
8
|
spec.email = ['noreply@kpn.com']
|
|
9
9
|
|
|
10
|
-
spec.summary = '
|
|
10
|
+
spec.summary = 'kpn style guides and shared style configs.'
|
|
11
11
|
spec.homepage = 'https://github.com/kpn-puppet/gem-kpn-style'
|
|
12
12
|
spec.license = 'Apache-2.0'
|
|
13
13
|
|
data/lib/kpn/style/version.rb
CHANGED
data/ruby-2.4.yml
CHANGED
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: kpn-style
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.1.
|
|
4
|
+
version: 0.1.3
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- kpn
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: exe
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2018-
|
|
11
|
+
date: 2018-11-06 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: rubocop
|
|
@@ -50,7 +50,6 @@ files:
|
|
|
50
50
|
- Gemfile
|
|
51
51
|
- LICENSE
|
|
52
52
|
- README.md
|
|
53
|
-
- RELEASING.md
|
|
54
53
|
- Rakefile
|
|
55
54
|
- kpn_style.gemspec
|
|
56
55
|
- lib/kpn/style.rb
|
|
@@ -78,8 +77,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
78
77
|
version: '0'
|
|
79
78
|
requirements: []
|
|
80
79
|
rubyforge_project:
|
|
81
|
-
rubygems_version: 2.
|
|
80
|
+
rubygems_version: 2.7.6
|
|
82
81
|
signing_key:
|
|
83
82
|
specification_version: 4
|
|
84
|
-
summary:
|
|
83
|
+
summary: kpn style guides and shared style configs.
|
|
85
84
|
test_files: []
|
data/RELEASING.md
DELETED
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
# Releasing
|
|
2
|
-
|
|
3
|
-
1. Update version.rb file accordingly.
|
|
4
|
-
1. Tag the release: `git tag VERSION`
|
|
5
|
-
1. Push changes: `git push --tags`
|
|
6
|
-
1. Update the release notes on GitHub.com
|
|
7
|
-
1. Build and publish:
|
|
8
|
-
|
|
9
|
-
```bash
|
|
10
|
-
bundle exec rake build
|
|
11
|
-
gem push pkg/kpn-style-X.XX.XX.gem
|
|
12
|
-
```
|
|
13
|
-
|
|
14
|
-
* Announce the new release,
|
|
15
|
-
making sure to say "thank you" to the contributors
|
|
16
|
-
who helped shape this version!
|