git-lint 1.0.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ea240069467c66adef23372741330ebd90180d3099cceb9c096ae9575eb4475
-  data.tar.gz: 8bec2e0c1d7348ee5af25a11641c8bd02d3773c055151c52252a69d5c2706daf
+  metadata.gz: fee007aea853b3ee86b0bbd66dc27b0debb3bdd69227cd693f989e470fdbaf25
+  data.tar.gz: a63392c0e6cf3dfa6cbd06bb361521327ea7326228c4b83163eba3d41435d762
 SHA512:
-  metadata.gz: 33c49480b58f1e6b44d4246f8306b8d9ba0ce68ca4cc059fe19a403a1d08fd50370f45a917eba39dbe5bf664d1377d044c20155b86c763307bdbd725d1bb95da
-  data.tar.gz: 598eb09a297689e9a930c01f46062fe9587fff7df02b430d74b69c9bd59af3e876a27e855b8d04cef3b4aec4ac8738a242797894a098c0bfcf28ee4a576d16c3
+  metadata.gz: 7c53d8b1657d48661796f82dba61954eb1f3ed17dac90d602ccd89147cae44efd3b9a1ed9b07bad5b5b53f61800f376f4f08053c4bbb76a3d287f2546e03536c
+  data.tar.gz: a5b6afdb80917dc75684878b0cd7679a240e76f6a8f17dc31d0b859aaeeba7d04e7d2bfe8ffe7175910c69f939391d0f0cf4001d5f0730b3af2cb7e31f9e69e5

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

@@ -2,24 +2,26 @@
 :toclevels: 5
 :figure-caption!:
 
-:git_rebase_workflow_link: link:https://www.alchemists.io/articles/git_commit_anatomy[Git Rebase Workflow]
+:git_rebase_workflow_link: link:https://www.alchemists.io/articles/git_rebase[Git Rebase Workflow]
 
 = Git Lint
 
 [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]
 
 [link=https://travis-ci.org/bkuhlmann/git-lint]
 image::https://travis-ci.org/bkuhlmann/git-lint.svg?branch=master[Travis CI Status]
 [link=https://app.netlify.com/sites/git-lint/deploys]
-image::https://api.netlify.com/api/v1/badges/d4a15c9c-46ba-49db-9f31-33f389ee3259/deploy-status[Netlify CI Status]
+image::https://api.netlify.com/api/v1/badges/7e23b422-3412-4e7f-b654-65c0417a0b1f/deploy-status[Netlify CI Status]
 
 A command line interface for linting Git commits. Ensures you maintain a clean, easy to read,
 debuggable, and maintainable project history.
 
-*Git Lint is the offical port of the original Git Cop project that avoids references to violence or
+*Git Lint is the official port of the original Git Cop project that avoids references to violence or
 violent terminology that might make anyone feel unwelcome. The name change was necessary in order to
 better support the link:https://blacklivesmatter.com[Black Lives Matter] and
 link:https://8cantwait.org[Defund Police] movements.*
@@ -37,16 +39,14 @@ toc::[]
 == Screencasts
 
 [link=https://www.alchemists.io/screencasts/git_lint]
-image::https://www.alchemists.io/images/screencasts/git_lint/cover-original.png[Screencast,role=focal_point]
+image::https://www.alchemists.io/images/screencasts/git_lint/cover.svg[Screencast,600,240,role=focal_point]
 
 == Requirements
 
-. link:https://www.ruby-lang.org[Ruby 2.7.0] (or higher)
+. link:https://www.ruby-lang.org[Ruby]
 
 == 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
@@ -849,7 +861,7 @@ worth considering:
 
 === General
 
-* Use a {git_rebase_workflow_link} instead of a Git merge workflow.
+* Use a {git_rebase_workflow_link} instead of a Git Merge Workflow.
 * Use `git commit --amend` when fixing a previous commit, addressing code review feedback, etc.
 * Use `git commit --fixup` when fixing an earlier commit, addressing code review feedback, etc., and
   don't need to modify the original commit message.
@@ -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.
@@ -1017,9 +1046,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 +1058,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.0"
+      VERSION = "1.3.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.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   2XV8FRa7/JimI07sPLC13eLY3xd/aYTi85Z782KIA4j0G8XEEWAX0ouBhlXPocZv
   QWc=
   -----END CERTIFICATE-----
-date: 2020-06-13 00:00:00.000000000 Z
+date: 2020-11-15 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.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.5'
+        version: '7.14'
 - !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
@@ -92,28 +92,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: bundler-leak
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: gemsmith
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '14.0'
+        version: '14.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '14.0'
+        version: '14.8'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -190,42 +204,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.83'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.83'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
@@ -246,28 +260,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.39'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.39'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.19'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.19'
 description:
 email:
 - brooke@alchemists.io
@@ -306,6 +320,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