git-lint 1.0.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41ebd28b9de6a2091463ebd909561803347a03806d4766b8f89427654e05f360
-  data.tar.gz: b361484f8086fd3e26a7e56ee7777a95efef5e721df3ea2d5a9b558834a67df2
+  metadata.gz: 6cb65f70f2b6923d02f717470a175b4a12f4aadf8f138ce2687ebdd73be3d300
+  data.tar.gz: 69a3dae72502594bd98c0397c29431bbfa4479fc6b5cebe8e76ce4149505085d
 SHA512:
-  metadata.gz: 8c94de6e225fa83c24130ed0e8128d9ee9ca9aa9fdc2b5852d2055a637e9e57ab8dc410842a8921fb1b0ca0e6aa6d1570d582fe57d509518d30e41dd7098d5f5
-  data.tar.gz: 474f3f1c1755a9745cf44813ed5ebfea9befe656426d27c2004508a416235378b2cfd7f49358829efb9862224d3faa12d5fad618ddb81fed3532b534910d238e
+  metadata.gz: 516084aa71ca86ec7fb5b4acbbc5eac343d6c4d44cc01ea8742c7882a3c203bafb9108fa788f0a00c4874bca40e810080b9b84d5d3ae583585e6efdef8166eb2
+  data.tar.gz: 1dbdb7ecf79311784ef01ede90695df2093fbd7d43b918e39d6bb596843bbaa87d6df59a8f57a901a8fdfb4cc5a935d92d7ad69bdde5f24ba0859f8d5efdb92f

data.tar.gz.sig

@@ -1,2 +1,3 @@
-Ԙ�L�P(��Ğ��3��AWF�.���^�%<�T^6����у�Ox��l�7�
-�kWFKKp*�Ȗ��D
+��)�*4�>{��K��O��B
+m����8��Tsb��j�Ҹ���~���댙k}H�� �2?��H�]�Xq> Pa�w
N�Vv��T��X㥇���Bı���jz8��;�
+	�Kؗ��*o4ؿ�b�wNN�����p}֎@�",�b�\�3�EN̅�L�*j��O���b}�ӅM9��ěe H�˳�P

data/LICENSE.adoc

@@ -150,7 +150,7 @@ additional liability.
 
 END OF TERMS AND CONDITIONS
 
-Copyright link:https://www.alchemists.io[Alchemists].
+Copyright 2020 link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in
 compliance with the License. You may obtain a link:https://www.apache.org/licenses/LICENSE-2.0[copy]

data/README.adoc

@@ -8,6 +8,8 @@
 
 [link=http://badge.fury.io/rb/git-lint]
 image::https://badge.fury.io/rb/git-lint.svg[Gem Version]
+[link=https://www.alchemists.io/projects/code_quality]
+image::https://img.shields.io/badge/code_style-alchemists-brightgreen.svg[Alchemists Style Guide]
 [link=https://circleci.com/gh/bkuhlmann/git-lint]
 image::https://circleci.com/gh/bkuhlmann/git-lint.svg?style=svg[Circle CI Status]
 
@@ -45,8 +47,6 @@ image::https://www.alchemists.io/images/screencasts/git_lint/cover.svg[Screencas
 
 == Setup
 
-=== Production
-
 To install, run:
 
 [source,bash]
@@ -54,24 +54,6 @@ To install, run:
 gem install git-lint
 ----
 
-=== Development
-
-To contribute, run:
-
-[source,bash]
-----
-git clone https://github.com/bkuhlmann/git-lint.git
-cd git-lint
-bin/setup
-----
-
-You can also use the IRB console for direct access to all objects:
-
-[source,bash]
-----
-bin/console
-----
-
 == Usage
 
 === Command Line Interface (CLI)
@@ -171,7 +153,7 @@ variables. The default configuration is:
   :severity: :error
   :includes: "\\-"
 :commit_body_issue_tracker_link:
-  :enabled: true,
+  :enabled: true
   :severity: :error
   :excludes:
     - "(f|F)ix(es|ed)?\\s\\#\\d+"
@@ -403,6 +385,36 @@ from `master`.
 Detection and configuration happens automatically by checking the `CIRCLECI` environment variable.
 No additional setup required!
 
+==== link:https://docs.github.com/en/free-pro-team@latest/actions[GitHub Actions]
+
+Detection happens automatically by checking the `GITHUB_ACTIONS` environment variable as supplied by
+the GitHub environment. The only configuration required is to add a `.github/workflows/git_lint.yml`
+to your repository with the following contents:
+
+[source,yaml]
+----
+name: Git Lint
+
+on: pull_request
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    container:
+      image: ruby:latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: '0'
+          ref: ${{github.head_ref}}
+      - name: Install
+        run: gem install git-lint
+      - name: Analyze
+        run: git-lint --analyze
+----
+
+The above will ensure Git Lint runs as an additional check on each Pull Request.
+
 ==== link:https://www.netlify.com[Netlify CI]
 
 Detection and configuration happens automatically by checking the `NETLIFY` environment variable. No
@@ -869,13 +881,30 @@ worth considering:
 * Avoid using link:https://git-scm.com/book/en/v2/Git-Tools-Submodules[Git Submodules]. This
   practice leads to complicated project cloning, deployments, maintenance, etc. Use separate
   repositories to better organize and split out this work. Sophisticated package managers, like
-  link:https://bundler.io[Bundler] for example, exist to manage these dependencies better than what
-  multiple Git Submodules can accomplish.
+  link:https://bundler.io[Bundler], exist to manage these dependencies better than what multiple Git
+  Submodules can accomplish.
 * Avoid using link:https://git-lfs.github.com[Git LFS] for tracking binary artifacts/resources.
   These files are not meant for version control and lead to large repositories that are time
   consuming to clone/deploy. Use storage managers, like link:https://aws.amazon.com/s3[Amazon S3]
   for example, that are better suited for binary assets that don't change often.
 
+=== Security
+
+Ensure signed commits, pushes, and tags are enabled within your global Git Configuration to reduce
+an
+link:https://blog.gruntwork.io/how-to-spoof-any-user-on-github-and-what-to-do-to-prevent-it-e237e95b8deb[attack
+vector]. Run the following commands to enable:
+
+[source,bash]
+----
+git config --global commit.gpgSign true
+git config --global push.gpgSign true
+git config --global tag.gpgSign true
+----
+
+⚠️ GitHub, unfortunately, doesn't support signed pushes so you might need to leave that
+configuration disabled.
+
 === Commits
 
 * Use a commit subject that explains _what_ is being committed.
@@ -886,14 +915,19 @@ worth considering:
 * Use small, atomic commits:
 ** Easier to review and provide feedback.
 ** Easier to review implementation and corresponding tests.
-** Easier to document with detailed subject messages (especially when grouped together in a pull
-   request).
+** Easier to document with detailed subjects (especially when grouped together in a pull request).
 ** Easier to reword, edit, squash, fix, or drop when interactively rebasing.
 ** Easier to combine together versus tearing apart a larger commit into smaller commits.
 * Use logically ordered commits:
 ** Each commit should tell a story and be a logical building block to the next commit.
+** Each commit should, ideally, be the implementation plus corresponding test. Avoid committing
+   changes that are a jumble of mixed ideas as they are hard to decipher and a huge insult not only
+   to the reviewer but your future self.
 ** Each commit, when reviewed in order, should be able to explain _how_ the feature or bug fix was
    completed and implemented properly.
+* Keep refactored code separate from behavioral changes. This makes the review process easier
+  because you don't have to sift through all the line and format changes to figure out what is new
+  or changed.
 
 === Branches
 
@@ -927,8 +961,11 @@ worth considering:
 
 === Code Reviews
 
-There are two objectives each code review should achieve:
+There are three main objectives each code review should achieve:
 
+. *Joy* - The experience of working with you, receiving feedback, giving feedback, and demonstrating
+   a level of care influences others and encourages a collaborative environment that is fun to work
+   in. Use this time to build and reinforce trust amongst your fellow colleagues.
 . *Quality*: Ensures changes are of highest quality that adhere to team standards while enhancing
    the customer experience and not disrupting their workflow.
 . *Education*: Provides a chance for everyone on the team to learn more about the architecture,
@@ -938,13 +975,22 @@ There are two objectives each code review should achieve:
 In addition to the objectives above, the following guidelines are worth following:
 
 * Keep code reviews short and easy to review:
+** Review your own code first before submitting to others. By ensuring your are confident in the
+   overall implementation and the commits in terms of commit messages and implementation details,
+   you'll encourage higher quality feedback and show appreciation for the reviewer's time.
 ** Provide a high level overview that answers _why_ the code review is necessary.
-** Provide a link to the issue/task that prompted the code review (if any).
+** Provide a link to the issue that prompted the code review (if any) and any additional details
+   worth highlighting to guide the reviewer through the process.
 ** Provide screenshots/screencasts if possible.
-** Ensure commits within the code review are related to the purpose of the code review.
-** Prefer code reviews at about 250 lines in order to keep the quality of the code review and defect
-   detection high.
-** Avoid working on a large issue without getting feedback first in order to not overwhelm/surprise
+** Provide any ancillary notes or points of interest worth highlighting for the reviewer.
+** Ensure commits within the code review are related to the purpose of the code review and avoid
+   mixing in changes that are ancillary to the primary objective of the code view. If you do have
+   changes outside of the scope of the current code review, open those changes up as a separate code
+   review instead.
+** Prefer code reviews at about 300 lines in order to keep the quality of the code review and defect
+   detection high. This also shows you value the reviewers time and attention away from their own
+   work.
+** Avoid working on a large issues without first getting feedback in order to not overwhelm/surprise
    the maintainers. More discussion up front will help ensure your work has a faster chance of
    acceptance.
 * Review and rebase code reviews quickly:
@@ -984,9 +1030,14 @@ In addition to the objectives above, the following guidelines are worth followin
     always meant as a response to helpful feedback.
 ** ✅ (`:white_check_mark:`) - Signifies code review approval. The author can
     rebase onto `master` and delete the feature branch at this point.
+* Use all feedback as a chance to learn, teach, strenghen the bond of trust between you and your
+  fellow colleagues, and avoid being cut by
+  link:https://fs.blog/2017/04/mental-model-hanlons-razor[Hanlon's Razor].
+* Use automation to ensure code reviews are consistent, of high quality, and swift to resolve. Each
+  code review can be an opportunity to identify and automate the process further.
 * Use face-to-face communication if a code review's written discussion gets lengthy/noisy.
-* Create new tasks/actions if additional features are discovered during a code review to avoid
-  delaying code review acceptance. Return to the code review once tasks have been logged.
+* Create follow-up actions if additional features are discovered during a code review to avoid
+  delaying code review acceptance. Return to the code review once the new actions have been logged.
 * The author, not the reviewer, should rebase the feature branch onto `master` upon approval.
 * Avoid reviewing your own code review before rebasing onto `master`. Have another pair of eyes
   review your code first.
@@ -1017,9 +1068,9 @@ do this, follow these steps:
 . Check _Require review from Code Owners_.
 . Check _Require status checks to pass before merging_.
 . Check _Require branches to be up to date before merging_.
+. Check _Require signed commits_.
 . Check _Require linear history_ (pairs well with the merge options mentioned above).
 . Check _Include administrators_.
-. Uncheck _Require signed commits_ (only necessary for tags).
 . Uncheck _Allow force pushes_.
 . Uncheck _Allow deletions_.
 
@@ -1029,6 +1080,24 @@ image::https://www.alchemists.io/images/projects/git-lint/screenshots/github-set
 
 Applying the above changes will help maintain a clean Git history.
 
+== Development
+
+To contribute, run:
+
+[source,bash]
+----
+git clone https://github.com/bkuhlmann/git-lint.git
+cd git-lint
+bin/setup
+----
+
+You can also use the IRB console for direct access to all objects:
+
+[source,bash]
+----
+bin/console
+----
+
 == Tests
 
 To test, run:

data/lib/git/lint.rb

@@ -15,6 +15,7 @@ require "git/lint/commits/saved"
 require "git/lint/commits/unsaved"
 require "git/lint/branches/environments/local"
 require "git/lint/branches/environments/circle_ci"
+require "git/lint/branches/environments/git_hub_action"
 require "git/lint/branches/environments/netlify_ci"
 require "git/lint/branches/environments/travis_ci"
 require "git/lint/branches/feature"

data/lib/git/lint/analyzers/abstract.rb

@@ -13,6 +13,7 @@ module Git
         ISSUE_LINE_OFFSET = 2
 
         def self.inherited klass
+          super
           @descendants ||= []
           @descendants << klass unless klass.to_s.start_with? "#<Class" # Ignore anonymous classes.
         end

data/lib/git/lint/analyzers/commit_body_bullet_delimiter.rb

@@ -32,7 +32,11 @@ module Git
         end
 
         def invalid_line? line
-          line.match?(/\A\s*#{Regexp.union filter_list.to_regexp}(?!\s).+\Z/)
+          line.match?(/\A\s*#{pattern}(?!(#{pattern}|\s)).+\Z/)
+        end
+
+        def pattern
+          Regexp.union filter_list.to_regexp
         end
       end
     end

data/lib/git/lint/analyzers/commit_body_leading_line.rb

@@ -14,9 +14,10 @@ module Git
         def valid?
           raw_body = commit.raw_body
           subject, body = raw_body.split "\n", 2
+
           return true if !String(subject).empty? && String(body).strip.empty?
 
-          raw_body.match?(/\A.+\n\n.+/)
+          raw_body.match?(/\A.+(\n\n|\#).+/m)
         end
 
         def issue

data/lib/git/lint/branches/environments/git_hub_action.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Branches
+      module Environments
+        # Provides GitHub Action build environment feature branch information.
+        class GitHubAction
+          def initialize repo: Git::Kit::Repo.new
+            @repo = repo
+          end
+
+          def name
+            "origin/#{repo.branch_name}"
+          end
+
+          def shas
+            repo.shas start: "origin/master", finish: name
+          end
+
+          private
+
+          attr_reader :repo
+        end
+      end
+    end
+  end
+end

data/lib/git/lint/branches/feature.rb

@@ -29,6 +29,7 @@ module Git
 
         def load_environment
           if key? "CIRCLECI" then Environments::CircleCI.new
+          elsif key? "GITHUB_ACTIONS" then Environments::GitHubAction.new
           elsif key? "NETLIFY" then Environments::NetlifyCI.new environment: current_environment
           elsif key? "TRAVIS" then Environments::TravisCI.new environment: current_environment
           else Environments::Local.new

data/lib/git/lint/identity.rb

@@ -6,7 +6,7 @@ module Git
     module Identity
       NAME = "git-lint"
       LABEL = "Git Lint"
-      VERSION = "1.0.1"
+      VERSION = "1.4.0"
       VERSION_LABEL = "#{LABEL} #{VERSION}"
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-lint
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   2XV8FRa7/JimI07sPLC13eLY3xd/aYTi85Z782KIA4j0G8XEEWAX0ouBhlXPocZv
   QWc=
   -----END CERTIFICATE-----
-date: 2020-07-23 00:00:00.000000000 Z
+date: 2020-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel
@@ -50,28 +50,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.5'
+        version: '7.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.5'
+        version: '7.16'
 - !ruby/object:Gem::Dependency
   name: runcom
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.4'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -86,188 +86,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.20'
-- !ruby/object:Gem::Dependency
-  name: bundler-audit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: gemsmith
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '14.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '14.2'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.7'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.13'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: reek
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.83'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.83'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.39'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.39'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.18'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.18'
 description:
 email:
 - brooke@alchemists.io
@@ -306,6 +124,7 @@ files:
 - lib/git/lint/analyzers/commit_trailer_collaborator_key.rb
 - lib/git/lint/analyzers/commit_trailer_collaborator_name.rb
 - lib/git/lint/branches/environments/circle_ci.rb
+- lib/git/lint/branches/environments/git_hub_action.rb
 - lib/git/lint/branches/environments/local.rb
 - lib/git/lint/branches/environments/netlify_ci.rb
 - lib/git/lint/branches/environments/travis_ci.rb
@@ -356,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.0
 signing_key:
 specification_version: 4
 summary: A command line interface for linting Git commits.