xlint 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44ff74fe99426f97c888147083f625d0a5cc9d60
-  data.tar.gz: 4a5537b2eafb5d7d5e071b1e1e0654be3807810f
+  metadata.gz: 57464a500839faac4d71aa2b0d125969425b93f4
+  data.tar.gz: 411c8fa3c67ba1598aaa3d82b844ec79cf1d58b7
 SHA512:
-  metadata.gz: e2fb76abcce5b30a6aec4c498049c775fb0462299e18fd08452e6b5be3f1cb1d6449773c099298eff13a5cad12c1d16d35674768636452c66c6820b33a0bbad1
-  data.tar.gz: 5918d137e4bf58c957b68d2aab5eba3a46bddea6f551d4416fbfeef6890ab6811d60e3ab9431e93c8490024353a38a841f791ec0520f5ac2d6706e4db1a97ab8
+  metadata.gz: be05a32d2196a4c2ba9f53e6d1da93e98afb65b4d9ece44d88557fcdc1f4665e3a27181a29a10a5821ab5e2a477a6bdd035855a4642fac419985433410b9b26b
+  data.tar.gz: 321dcddf0ed6b695cd4209ef2e5ac92c06a8e921cf1be28f8a833be9f469ef8b1c8b0a804e9e6e3cb1e17920473825adffa97a52b7c0c998c081e5dec8aa8258

data/README.md

@@ -18,14 +18,14 @@ in the Gerrit review.
 Xlint parses the changes in a patchset, and runs each change through
 a validator. If the validator detects any issues, a [Gergich](https://rubygems.org/gems/gergich)
 comment is created. After all the changes have been checked, Xlint
-publishes the Gergich comments to Gerrit.
+publishes the Gergich comments to Gerrit. If the CI environment has a variable for a Gerrit review label, Xlint will also post a reply to the label.
 
 ## Limitations
 
 Xlint currently only detects changes to the deployment target within
 Xcode .pbxproj files.
 
-## Installation
+## Installation and Usage
 
 [Gergich][gergich] and Gerrit must be configured as defined in the Gergich gem. If
 [Gergich][gergich] works, then all you need to do is `gem install xlint` and Xlint
@@ -33,14 +33,116 @@ is ready for linting.
 
 [gergich]: https://github.com/instructure/gergich
 
-## Usage
+### Setup Gerrit and Gergich Environment Variables on Jenkins
+* Install EnvInject Jenkins Plugin (Manage Jenkins > Manage Plugins > Available Filter: EnvInject)
+Note: The Jenkins version on Cloudbees does not currently work with EnvInject.
+* Add the following Global property (Jenkins Configuration > Global Properties)
 
-Xlint requires patchset changes be saved to a file and the filepath
-passed to Xlint as a command-line argument.
+> GERGICH_KEY
+```
+Name: GERGICH_KEY
+Value: <access_key_for_gergich_user_on_gerrit>
+```
+
+* Check "This project is parameterized" (Job Configuration > General)
+* Add the following String Parameters to (Job Configuration > General
+
+> GERRIT_REFSPEC
+```
+Name: GERRIT_REFSPEC
+Default Value: HEAD:refs/for
+```
+
+> GERRIT_BRANCH
+```
+Name: GERRIT_BRANCH
+Default Value: develop 
+```
 
-## Example
+> GERGICH_REVIEW_LABEL
+```
+Name: GERGICH_REVIEW_LABEL
+Default Value: Lint-Review
+```
 
+* Check "Inject environment variables to the build process" (Job Configuration > Build Environment)
+
+### Setup Lint-Review on Gerrit
+In the meta/config branch of your Gerrit project, you need to add "Linter Bots" to your groups file, create the Lint-Review label, and grant access to bots in the project.config file.
+
+> groups
+```
+# UUID                                Group Name
+#
+<uuid_for_developers_group>           Developers
+<uuid_for_robots_group>               Robots
+<uuid_for_administrators_group>       Administrators
+<uuid_for_linter_bots_group>          Linter Bots
 ```
+
+> project.config
+```
+[access "refs/*"]
+    owner = group Administrators
+    owner = group Developers
+    read = group Robots
+[label "Lint-Review"]
+    function = AnyWithBlock
+    abbreviation = L
+    value = -2 Error
+    value = -1 Warning
+    value =  0 No score
+    value = +1 Verified
+    defaultValue = 0
+[access "refs/heads/*"]
+    label-Lint-Review = -2..1 group Linter Bots
+```
+
+* For additional information on Gerrit project labels, [review the Gerrit documentation](https://gerrit-review.googlesource.com/Documentation/config-labels.html)
+
+* How do I checkout, commit, and push to the meta/config branch?
+    * ``` git fetch origin refs/meta/config:refs/remotes/origin/meta/config ```
+    * ``` git checkout meta/config ```
+    * ``` git add project.config ```
+    * ``` git commit -m "add Lint-Review" ```
+    * ``` git push origin HEAD:refs/meta/config ```
+
+### Setup Xlint to Run in Jenkins Job
+Add the following to build script (Job Configuration > Build > Execute Shell > Command)
+``` bash
+#!/bin/bash --login
+
+ruby -v
+
+if ! gem list xlint -i; then
+    gem install --no-document xlint
+else
+    gem update xlint
+fi
+
 git diff HEAD~1 HEAD > changes.diff
 xlint changes.diff
+
+# if using Fastlane
+# fastlane lint
+
+echo ''
+echo 'Gergich Status:'
+gergich status
+```
+
+Add a lint lane to Fastlane:
+``` ruby
+desc 'Xlint'
+  lane :lint do
+    if ENV['GERRIT_PROJECT']
+      changes_diff = 'changes.diff'
+      sh "git diff HEAD~1 HEAD > #{changes_diff}"
+      begin
+        sh "xlint #{changes_diff}"
+      ensure
+        File.delete(changes_diff) if File.exists?(changes_diff)
+      end
+    end
+  end
 ```

data/lib/xlint.rb

@@ -90,7 +90,7 @@ class Xlint
 
     # expects git header in the form of: @@ -215,13 +215,7 @@
     def starting_line_number(header)
-      str = header.split(' ')[1].split(',')[0]
+      str = header.split(' ')[2].split(',')[0]
       str.slice!('-')
       str.to_i
     end

data/lib/xlint/version.rb

@@ -1,3 +1,3 @@
 class Xlint
-  VERSION = '0.0.5'.freeze unless defined? ::Xlint::VERSION
+  VERSION = '0.0.6'.freeze unless defined? ::Xlint::VERSION
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xlint
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Taylor Wilson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-19 00:00:00.000000000 Z
+date: 2016-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -291,8 +291,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.3
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Command-line tool for linting Xcode project files.
 test_files: []
+has_rdoc: