git-lint 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba39bef55a904dc640ba7421df9016597bc826faf3263eddb5f3bff2036a00b4
-  data.tar.gz: 4ea42cc58c1cdb23fff6bd0625e23573b0c13831c4a75115a08fc9d751a32088
+  metadata.gz: 1a0ccd4d14bc5a75b14ae5a825f5eec453a560bc3e6df2bc959bbcb90f626794
+  data.tar.gz: 5f64925793493c9cde59a4828666137ba6a5203f664d5b97ce994552b38fcb42
 SHA512:
-  metadata.gz: 86c24491442dc4e817693138a5b0b822137e2c0627a8c5808576bdee1128480d310269852f013eee7b25cb097ea07ffc6f7f211a2e628b2d88dd97e7f8a26f84
-  data.tar.gz: acfebc2a5e4f373304f553af56d01f4c6309726d1ac09b1ec1e0edb4cdf76ea3a63fa4d977f6e974b1ed92a6312a5594e18bcd67116f2fd72fd585621a8f5a5c
+  metadata.gz: b295196574a134f2ae5a3989c71d7023998eaf96476055a8c511a3f5d684fbaf1d9456fe887389042d4f8a88fb0d7bce0ea8e1a5663c490c1cf7756b9d6384c8
+  data.tar.gz: 542818d4e2dced990b4231b53160e6c59272c1db908e309a10566210be26eeddb6213ec1f6581c75b078f6d8581e0b4f85827efe03d0f93ce9a216a8133c94a8

data/README.adoc

@@ -14,7 +14,7 @@ image::https://img.shields.io/badge/code_style-alchemists-brightgreen.svg[Alchem
 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]
+image::https://travis-ci.org/bkuhlmann/git-lint.svg?branch=main[Travis CI Status]
 [link=https://app.netlify.com/sites/git-lint/deploys]
 image::https://api.netlify.com/api/v1/badges/7e23b422-3412-4e7f-b654-65c0417a0b1f/deploy-status[Netlify CI Status]
 
@@ -27,9 +27,10 @@ toc::[]
 
 * Enforces a {git_rebase_workflow_link}.
 * Enforces a clean and consistent Git commit history.
+* Supports Git default branch configuration.
 * Provides a customizable suite of analyzers.
 * Provides Git Hook support for local use.
-* Provides Continuous Integration (CI) build server support.
+* Provides Continuous Integration (CI) support.
 
 == Screencasts
 
@@ -66,9 +67,9 @@ git-lint -v, [--version]       # Show gem version.
 To check if your Git commit history is clean, run: `git-lint --analyze`. It will exit with a failure
 if at least one issue with error severity is detected.
 
-This gem does not check commits on `master`. This is intentional as you would, generally, not want
-to rewrite or fix commits on `master`. This gem is best used on feature branches as it automatically
-detects all commits made since `master` on the feature branch.
+This gem does not check commits on your default branch (i.e. `main`). This is intentional as you
+would, generally, not want to rewrite or fix commits on the `main` branch. This gem is best used on
+feature branches as it automatically detects all commits made since creation of the feature branch.
 
 Here is an example workflow, using gem defaults with issues detected:
 
@@ -110,6 +111,21 @@ Now, when running `bundle exec rake -T`, you'll see `git_lint` included in the l
 
 If you need a concrete example, check out the link:Rakefile[Rakefile] of this project for details.
 
+=== Default Branch
+
+Your default branch configuration is respected no matter if it is set globally or locally. If the
+default branch is _not set_ then Git Lint will fall back to `master` for backwards compatibility.
+When the next major version is released, the default branch fallback will change from `master` to
+`main`. You can set your default branch at any time by running the following from the command line:
+
+[source,bash]
+----
+git config --add init.defaultBranch main
+----
+
+💡 When setting your default branch, ensure you use a consistent Git configuration across all of
+your environments.
+
 === Configuration
 
 This gem can be configured via a global configuration:
@@ -288,7 +304,7 @@ maintenance costs for you. To configure global Git Hooks, add the following to y
 ....
 
 Then you can customize Git Hooks for all of your projects.
-link:https://github.com/bkuhlmann/dotfiles/tree/master/home_files/.config/git/hooks[Check out these
+link:https://github.com/bkuhlmann/dotfiles/tree/main/home_files/.config/git/hooks[Check out these
 examples].
 
 If a global configuration is not desired, you can add Git Hooks at a per project level by editing
@@ -373,7 +389,7 @@ have a build server that is not listed, please log an issue or provide an implem
 support.
 
 Calculation of commits is done by reviewing all commits made on the feature branch since branching
-from `master`.
+from `main`.
 
 ==== link:https://circleci.com[Circle CI]
 
@@ -865,7 +881,7 @@ worth considering:
   blindly combine multiple commit messages without editing them into a single, coherent message._
 * Use `git rebase --interactive` when cleaning up commit history, order, messages, etc. This should
   be done prior to submitting a code review or when code review feedback has been addressed and
-  you are ready to rebase onto `master`.
+  you are ready to rebase onto `main`.
 * Use `git push --force-with-lease` instead of `git push --force` when pushing changes after an
   interactive rebasing session.
 * Avoid checking in development-specific configuration files (add to `.gitignore` instead).
@@ -927,7 +943,7 @@ configuration disabled.
 === Branches
 
 * Use feature branches for new work.
-* Maintain branches by rebasing upon `master` on a regular basis.
+* Maintain branches by rebasing upon `main` on a regular basis.
 
 === Tags
 
@@ -949,7 +965,7 @@ configuration disabled.
 * Use hooks globally rather than locally per project. Doing this applies the same functionality
   across all projects automatically, reduces maintenance per project, and provides consistency
   across all projects. This can best be managed via your
-  link:https://github.com/bkuhlmann/dotfiles/tree/master/home_files/.config/git/hooks[Dotfiles].
+  link:https://github.com/bkuhlmann/dotfiles/tree/main/home_files/.config/git/hooks[Dotfiles].
 * Avoid forcing global or local project hooks as a team-wide mandate. Hooks are a personal tool much
   like editors or other tools one choose to do their work. For team consistency, use a continuous
   integration build server instead.
@@ -1016,15 +1032,15 @@ In addition to the objectives above, the following guidelines are worth followin
     implementation. This is _blocking_ and requires immediate correction. The reviewer should
     provide a suggested solution and/or links to patterns, articles, etc. that might help the author
     fix the implementation. Pairing is encouraged if feedback is vast and/or complex.
-** 🔒 (`:lock:`) - Signifies a security violation that would damage us and/or our customers. This is
-   _blocking_ feedback and must be addressed immediately.
+** 🔓 (`:unlock:`) - Signifies a security violation that would damage us and/or our customers. This
+   is _blocking_ feedback and must be addressed immediately.
 ** 💡 (`:bulb:`) - Indicates a helpful tip or trick for improving the code. This can be
     _blocking_ or _non-blocking_ feedback and is left up to the author to decide. Generally, it is a
     good idea to address and resolve the feedback.
 ** 🙇 (`:bow:`) - Indicates thankfulness of the feedback received. This is _non-blocking_ and
     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.
+    rebase onto `main` 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].
@@ -1033,13 +1049,13 @@ In addition to the objectives above, the following guidelines are worth followin
 * Use face-to-face communication if a code review's written discussion gets lengthy/noisy.
 * 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
+* The author, not the reviewer, should rebase the feature branch onto `main` upon approval.
+* Avoid reviewing your own code review before rebasing onto `main`. Have another pair of eyes
   review your code first.
-* Ensure the following criteria is met before rebasing your feature branch to `master`:
+* Ensure the following criteria is met before rebasing your feature branch to `main`:
 ** Ensure all `fixup!` and `squash!` commits are interactively rebased. _Avoid rebasing these onto
-   the `master` branch!_
-** Ensure your feature branch is rebased upon `master`.
+   the `main` branch!_
+** Ensure your feature branch is rebased upon `main`.
 ** Ensure all tests and code quality checks are passing.
 ** Ensure the feature branch is deleted after being successfully rebased.
 
@@ -1051,12 +1067,12 @@ and editing your merge options for code reviews as follows:
 
 image::https://www.alchemists.io/images/projects/git-lint/screenshots/github-settings-options.png[GitHub Merge Options]
 
-In addition to the above, you'll want to add _branch_ protection rules for your `master` branch. To
+In addition to the above, you'll want to add _branch_ protection rules for your `main` branch. To
 do this, follow these steps:
 
 . Visit your branch settings (i.e. `https://github.com/<username>/<project>/settings/branches`).
 . Click the _Add rule_ button.
-. For _branch name pattern_, enter: `master`.
+. For _branch name pattern_, enter: `main`.
 . Check _Require pull request reviews before merging_.
 . Set _Required approving reviews_ to `2` as a minimum.
 . Check _Dismiss stale pull request approvals when new commits are pushed_.

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

@@ -15,7 +15,7 @@ module Git
           end
 
           def commits
-            repository.commits "origin/master..#{name}"
+            repository.commits "origin/#{repository.branch_default}..#{name}"
           end
 
           private

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

@@ -15,7 +15,7 @@ module Git
           end
 
           def commits
-            repository.commits "origin/master..#{name}"
+            repository.commits "origin/#{repository.branch_default}..#{name}"
           end
 
           private

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

@@ -15,7 +15,7 @@ module Git
           end
 
           def commits
-            repository.commits "master..#{name}"
+            repository.commits "#{repository.branch_default}..#{name}"
           end
 
           private

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

@@ -21,7 +21,7 @@ module Git
           def commits
             shell.capture3 "git remote add -f origin #{environment["REPOSITORY_URL"]}"
             shell.capture3 "git fetch origin #{name}:#{name}"
-            repository.commits "origin/master..origin/#{name}"
+            repository.commits "origin/#{repository.branch_default}..origin/#{name}"
           end
 
           private

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

@@ -20,7 +20,7 @@ module Git
 
           def commits
             prepare_project
-            repository.commits "origin/master..#{name}"
+            repository.commits "origin/#{repository.branch_default}..#{name}"
           end
 
           private
@@ -35,7 +35,7 @@ module Git
               shell.capture3 "git fetch original_branch #{name}:#{name}"
             end
 
-            shell.capture3 "git remote set-branches --add origin master"
+            shell.capture3 "git remote set-branches --add origin #{repository.branch_default}"
             shell.capture3 "git fetch"
           end
 

data/lib/git/lint/identity.rb

@@ -6,7 +6,7 @@ module Git
     module Identity
       NAME = "git-lint"
       LABEL = "Git Lint"
-      VERSION = "2.1.0"
+      VERSION = "2.2.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: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -10,9 +10,9 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIC/jCCAeagAwIBAgIBAzANBgkqhkiG9w0BAQsFADAlMSMwIQYDVQQDDBpicm9v
-  a2UvREM9YWxjaGVtaXN0cy9EQz1pbzAeFw0yMDAzMTUxNDQ1MzJaFw0yMTAzMTUx
-  NDQ1MzJaMCUxIzAhBgNVBAMMGmJyb29rZS9EQz1hbGNoZW1pc3RzL0RDPWlvMIIB
+  MIIC/jCCAeagAwIBAgIBBDANBgkqhkiG9w0BAQsFADAlMSMwIQYDVQQDDBpicm9v
+  a2UvREM9YWxjaGVtaXN0cy9EQz1pbzAeFw0yMTAzMTkxMjQ4MDZaFw0yMjAzMTkx
+  MjQ4MDZaMCUxIzAhBgNVBAMMGmJyb29rZS9EQz1hbGNoZW1pc3RzL0RDPWlvMIIB
   IjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6l1qpXTiomH1RfMRloyw7MiE
   xyVx/x8Yc3EupdH7uhNaTXQGyORN6aOY//1QXXMHIZ9tW74nZLhesWMSUMYy0XhB
   brs+KkurHnc9FnEJAbG7ebGvl/ncqZt72nQvaxpDxvuCBHgJAz+8i5wl6FhLw+oT
@@ -20,15 +20,15 @@ cert_chain:
   D5vkU0YlAm1r98BymuJlcQ1qdkVEI1d48ph4kcS0S0nv1RiuyVb6TCAR3Nu3VaVq
   3fPzZKJLZBx67UvXdbdicWPiUR75elI4PXpLIic3xytaF52ZJYyKZCNZJhNwfQID
   AQABozkwNzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU0nzow9vc
-  2CdikiiE3fJhP/gY4ggwDQYJKoZIhvcNAQELBQADggEBAIHhAlD3po4sTYqacXaQ
-  XI9jIhrfMy//2PgbHWcETtlJPBeNUbbSNBABcllUHKqYsVDlSvSmss034KSWNR8F
-  bF1GcloicyvcCC4y6IoW4it0COAcdeaaxkxiBSgKdQFpff9REnDlIKK4uQ9lLxIo
-  Y2G5xubiziKZkyfWFuSr67PIjW3Bu673D1JVBArhA1qbgQmYQcy1CkGOjo+iO8Nf
-  7u/QSfBHb+r/bXhKscDgPpnKwbUmvgO2+94zJG9KsrmIydlzYfsD09aXKx0t6Xy4
-  2XV8FRa7/JimI07sPLC13eLY3xd/aYTi85Z782KIA4j0G8XEEWAX0ouBhlXPocZv
-  QWc=
+  2CdikiiE3fJhP/gY4ggwDQYJKoZIhvcNAQELBQADggEBAEjpaOXHHp8s/7GL2qCb
+  YAs7urOLv9VHSPfQWAwaTMVnSsIf3Sw4xzISOP/mmfEPBPXtz61K5esrE/uTFtgb
+  FyjxQk2H0sEWgrRXGGNHBWQRhhEs7LP/TByoC15A0br++xLxRz4r7HBLGAWQQDpg
+  66BJ2TBVjxS6K64tKbq7+ACyrOZGgTfNHACh4M076y0x0oRf/rwBrU39/KRfuhbb
+  cm+nNCEtO35gTmZ2bVDHLGvWazi3gJt6+huQjfXTCUUG2YYBxwhu+GPdAGQPxpf9
+  lkHilIrX69jq8wMPpBhlaw2mRmeSL50Wv5u6xVBvOHhXFSP1crXM95vfLhLyRYod
+  W2A=
   -----END CERTIFICATE-----
-date: 2021-01-19 00:00:00.000000000 Z
+date: 2021-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git_plus
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: pastel
   requirement: !ruby/object:Gem::Requirement
@@ -186,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.5
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: A command line interface for linting Git commits.