git-lint 4.4.0 → 4.6.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- checksums.yaml.gz.sig +0 -0
- data/README.adoc +191 -189
- data/git-lint.gemspec +8 -8
- data/lib/git/lint/cli/actions/import.rb +2 -2
- data/lib/git/lint/commits/systems/import.rb +2 -2
- data/lib/git/lint/import.rb +2 -2
- data.tar.gz.sig +0 -0
- metadata +21 -21
- metadata.gz.sig +0 -0
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d02f9170b8002b1fec4f4c37602195fe1c097a9fb7a48dd29b7fea2f6d7d2fa8
|
4
|
+
data.tar.gz: 2d3f96fedecaa53da9f889ea11ee299c72ba6128fb83fa1773341e0140226f57
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ded52e449c9ff4b05b0327976eec0534964d7b596130221ef14449b8a0b0e7d214d0dfe8c8b2846d7f057d578fae927825228ac1e2a1dbfa6b86dbae3b29495b
|
7
|
+
data.tar.gz: 6b846bc2625c81485f39ae22a4cb28623dbaf698ea7ff70d191a5ed94e470ab54e5097093ce3fce08cfc06e92094afdef1880d4cd85bf751a9d08c9dfefaf98d
|
checksums.yaml.gz.sig
CHANGED
Binary file
|
data/README.adoc
CHANGED
@@ -88,36 +88,6 @@ Running Git Lint...
|
|
88
88
|
1 commit inspected. 4 issues detected (1 warning, 3 errors).
|
89
89
|
....
|
90
90
|
|
91
|
-
=== Rake
|
92
|
-
|
93
|
-
This gem provides optional Rake tasks. They can be added to your project by adding the following
|
94
|
-
requirement to the top of your `Rakefile`:
|
95
|
-
|
96
|
-
[source,ruby]
|
97
|
-
----
|
98
|
-
require "git/lint/rake/setup"
|
99
|
-
----
|
100
|
-
|
101
|
-
Now, when running `bundle exec rake -T`, you'll see `git_lint` included in the list.
|
102
|
-
|
103
|
-
If you need a concrete example, check out the
|
104
|
-
link:https://github.com/bkuhlmann/git-lint/blob/main/Rakefile[Rakefile] of this project for details.
|
105
|
-
|
106
|
-
=== Default Branch
|
107
|
-
|
108
|
-
Your default branch configuration is respected no matter if it is set globally or locally. If the
|
109
|
-
default branch is _not set_ then Git Lint will fall back to `master` for backwards compatibility.
|
110
|
-
When the next major version is released, the default branch fallback will change from `master` to
|
111
|
-
`main`. You can set your default branch at any time by running the following from the command line:
|
112
|
-
|
113
|
-
[source,bash]
|
114
|
-
----
|
115
|
-
git config --add init.defaultBranch main
|
116
|
-
----
|
117
|
-
|
118
|
-
💡 When setting your default branch, ensure you use a consistent Git configuration across all of
|
119
|
-
your environments.
|
120
|
-
|
121
91
|
=== Configuration
|
122
92
|
|
123
93
|
This gem can be configured via a global configuration:
|
@@ -255,12 +225,12 @@ variables. The default configuration is:
|
|
255
225
|
Feel free to take this default configuration, modify, and save as your own custom
|
256
226
|
`configuration.yml`.
|
257
227
|
|
258
|
-
|
228
|
+
==== Enablement
|
259
229
|
|
260
230
|
By default, most analyzers are enabled. Accepted values are `true` or `false`. If you wish to
|
261
231
|
disable a analyzer, set it to `false`.
|
262
232
|
|
263
|
-
==== Severity
|
233
|
+
==== Severity
|
264
234
|
|
265
235
|
By default, most analyzers are set to `error` severity. If you wish to reduce the severity level of
|
266
236
|
a analyzer, you can set it to `warn` instead. Here are the accepted values and what each means:
|
@@ -283,146 +253,12 @@ want to turn into regular expressions. _For purposes of the YAML configuration,
|
|
283
253
|
expressed as strings with special characters escaped properly for internal conversion to a regular
|
284
254
|
expression._
|
285
255
|
|
286
|
-
===
|
287
|
-
|
288
|
-
This gem supports link:https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks[Git Hooks].
|
289
|
-
|
290
|
-
It is _highly recommended_ you manage Git Hooks as global scripts as it'll reduce project
|
291
|
-
maintenance costs for you. To configure global Git Hooks, add the following to your
|
292
|
-
`$HOME/.gitconfig`:
|
293
|
-
|
294
|
-
....
|
295
|
-
[core]
|
296
|
-
hooksPath = ~/.git_template/hooks
|
297
|
-
....
|
298
|
-
|
299
|
-
Then you can customize Git Hooks for all of your projects.
|
300
|
-
link:https://github.com/bkuhlmann/dotfiles/tree/main/home_files/.config/git/hooks[Check out these
|
301
|
-
examples].
|
302
|
-
|
303
|
-
If a global configuration is not desired, you can add Git Hooks at a per project level by editing
|
304
|
-
any of the scripts within the `.git/hooks` directory of the repository.
|
305
|
-
|
306
|
-
==== Commit Message
|
307
|
-
|
308
|
-
The _commit-msg_ hook -- which is the best way to use this gem as a Git Hook -- is provided as a
|
309
|
-
`--hook` option. Usage:
|
310
|
-
|
311
|
-
[source,bash]
|
312
|
-
----
|
313
|
-
git-lint --hook PATH
|
314
|
-
----
|
315
|
-
|
316
|
-
As shown above, the `--hook` command accepts a file path (i.e. `.git/COMMIT_EDITMSG`) which
|
317
|
-
is provided to you by Git within the `.git/hooks/commit-msg` script. Here is a working example of
|
318
|
-
what that script might look like:
|
319
|
-
|
320
|
-
[source,bash]
|
321
|
-
----
|
322
|
-
#! /usr/bin/env bash
|
323
|
-
|
324
|
-
set -o nounset
|
325
|
-
set -o errexit
|
326
|
-
set -o pipefail
|
327
|
-
IFS=$'\n\t'
|
328
|
-
|
329
|
-
if ! command -v git-lint > /dev/null; then
|
330
|
-
printf "%s\n" "[git]: Git Lint not found. To install, run: gem install git-lint."
|
331
|
-
exit 1
|
332
|
-
fi
|
333
|
-
|
334
|
-
git-lint --hook "${BASH_ARGV[0]}"
|
335
|
-
----
|
336
|
-
|
337
|
-
Whenever you attempt to add a commit, Git Lint will check your commit for issues prior to saving it.
|
338
|
-
|
339
|
-
==== Post Commit
|
340
|
-
|
341
|
-
The _post-commit_ hook is possible via the `--analyze` command. Usage:
|
342
|
-
|
343
|
-
[source,bash]
|
344
|
-
----
|
345
|
-
git-lint --analyze --shas SHA
|
346
|
-
----
|
347
|
-
|
348
|
-
The _post-commit_ hook can be used multiple ways but, generally, you'll want to check the last
|
349
|
-
commit made. Here is a working example which can be used as a `.git/hooks/post-commit` script:
|
350
|
-
|
351
|
-
[source,bash]
|
352
|
-
----
|
353
|
-
#! /usr/bin/env bash
|
354
|
-
|
355
|
-
set -o nounset
|
356
|
-
set -o errexit
|
357
|
-
set -o pipefail
|
358
|
-
IFS=$'\n\t'
|
359
|
-
|
360
|
-
if ! command -v git-lint > /dev/null; then
|
361
|
-
printf "%s\n" "[git]: Git Lint not found. To install, run: gem install git-lint."
|
362
|
-
exit 1
|
363
|
-
fi
|
364
|
-
|
365
|
-
git-lint --analyze --shas $(git log --pretty=format:%H -1)
|
366
|
-
----
|
367
|
-
|
368
|
-
Whenever a commit has been saved, this script will run Git Lint to check for issues.
|
369
|
-
|
370
|
-
=== Continuous Integration (CI)
|
371
|
-
|
372
|
-
This gem automatically configures itself for known CI build servers (see below for details). If you
|
373
|
-
have a build server that is not listed, please log an issue or provide an implementation with
|
374
|
-
support.
|
375
|
-
|
376
|
-
Calculation of commits is done by reviewing all commits made on the feature branch since branching
|
377
|
-
from `main`.
|
378
|
-
|
379
|
-
==== link:https://circleci.com[Circle CI]
|
380
|
-
|
381
|
-
Detection and configuration happens automatically by checking the `CIRCLECI` environment variable.
|
382
|
-
No additional setup required!
|
383
|
-
|
384
|
-
==== link:https://docs.github.com/en/free-pro-team@latest/actions[GitHub Actions]
|
385
|
-
|
386
|
-
Detection happens automatically by checking the `GITHUB_ACTIONS` environment variable as supplied by
|
387
|
-
the GitHub environment. The only configuration required is to add a `.github/workflows/git_lint.yml`
|
388
|
-
to your repository with the following contents:
|
389
|
-
|
390
|
-
[source,yaml]
|
391
|
-
----
|
392
|
-
name: Git Lint
|
393
|
-
|
394
|
-
on: pull_request
|
395
|
-
|
396
|
-
jobs:
|
397
|
-
run:
|
398
|
-
runs-on: ubuntu-latest
|
399
|
-
container:
|
400
|
-
image: ruby:latest
|
401
|
-
steps:
|
402
|
-
- name: Checkout
|
403
|
-
uses: actions/checkout@v2
|
404
|
-
with:
|
405
|
-
fetch-depth: '0'
|
406
|
-
ref: ${{github.head_ref}}
|
407
|
-
- name: Install
|
408
|
-
run: gem install git-lint
|
409
|
-
- name: Analyze
|
410
|
-
run: git-lint --analyze
|
411
|
-
----
|
412
|
-
|
413
|
-
The above will ensure Git Lint runs as an additional check on each Pull Request.
|
414
|
-
|
415
|
-
==== link:https://www.netlify.com[Netlify CI]
|
416
|
-
|
417
|
-
Detection and configuration happens automatically by checking the `NETLIFY` environment variable. No
|
418
|
-
additional setup required!
|
419
|
-
|
420
|
-
== Analyzers
|
256
|
+
=== Analyzers
|
421
257
|
|
422
258
|
The following details the various analyzers provided by this gem to ensure a high standard of
|
423
259
|
commits for your project.
|
424
260
|
|
425
|
-
|
261
|
+
==== Commit Author Capitalization
|
426
262
|
|
427
263
|
[options="header"]
|
428
264
|
|===
|
@@ -442,7 +278,7 @@ Jayne Cobb
|
|
442
278
|
Dr. Simon Tam
|
443
279
|
....
|
444
280
|
|
445
|
-
|
281
|
+
==== Commit Author Email
|
446
282
|
|
447
283
|
[options="header"]
|
448
284
|
|===
|
@@ -461,7 +297,7 @@ mudder_man
|
|
461
297
|
jayne@serenity.com
|
462
298
|
....
|
463
299
|
|
464
|
-
|
300
|
+
==== Commit Author Name
|
465
301
|
|
466
302
|
[options="header"]
|
467
303
|
|===
|
@@ -479,7 +315,7 @@ Kaylee
|
|
479
315
|
Kaywinnet Lee Frye
|
480
316
|
....
|
481
317
|
|
482
|
-
|
318
|
+
==== Commit Body Bullet
|
483
319
|
|
484
320
|
[options="header"]
|
485
321
|
|===
|
@@ -499,7 +335,7 @@ It's best to use dashes for bullet point syntax as stars are easier to read when
|
|
499
335
|
_emphasis_. This makes parsing the Markdown syntax easier when reviewing a Git commit as the syntax
|
500
336
|
used for bullet points and _emphasis_ are now, distinctly, unique.
|
501
337
|
|
502
|
-
|
338
|
+
==== Commit Body Bullet Capitalization
|
503
339
|
|
504
340
|
[options="header"]
|
505
341
|
|===
|
@@ -517,7 +353,7 @@ Ensures commit body bullet lines are capitalized. Example:
|
|
517
353
|
- An example bullet.
|
518
354
|
....
|
519
355
|
|
520
|
-
|
356
|
+
==== Commit Body Bullet Delimiter
|
521
357
|
|
522
358
|
[options="header"]
|
523
359
|
|===
|
@@ -535,7 +371,7 @@ Ensures commit body bullets are delimited by a space. Example:
|
|
535
371
|
- An example bullet.
|
536
372
|
....
|
537
373
|
|
538
|
-
|
374
|
+
==== Commit Body Leading Line
|
539
375
|
|
540
376
|
[options="header"]
|
541
377
|
|===
|
@@ -566,7 +402,7 @@ egestas semper. Aenean ultricies mi vitae est. Mauris placerat's eleifend leo. Q
|
|
566
402
|
ullamcorper pharetra. Vestibulum erat wisi, condimentum sed, commodo vitae, orn si amt wit.
|
567
403
|
....
|
568
404
|
|
569
|
-
|
405
|
+
==== Commit Body Line Length
|
570
406
|
|
571
407
|
[options="header"]
|
572
408
|
|===
|
@@ -578,7 +414,7 @@ Ensures each line of the commit body doesn't force you to scroll horizontally to
|
|
578
414
|
This allows commit messages to remain readable and is especially handy when commit messages are read
|
579
415
|
via the command line or email clients.
|
580
416
|
|
581
|
-
|
417
|
+
==== Commit Body Paragraph Capitalization
|
582
418
|
|
583
419
|
[options="header"]
|
584
420
|
|===
|
@@ -596,7 +432,7 @@ curabitur eleifend wisi iaculis ipsum.
|
|
596
432
|
Curabitur eleifend wisi iaculis ipsum.
|
597
433
|
....
|
598
434
|
|
599
|
-
|
435
|
+
==== Commit Body Phrase
|
600
436
|
|
601
437
|
[options="header"]
|
602
438
|
|===
|
@@ -621,7 +457,7 @@ Necessary to fix due to a bug detected in production. The included implementatio
|
|
621
457
|
and provides the missing spec to ensure this doesn't happen again.
|
622
458
|
....
|
623
459
|
|
624
|
-
|
460
|
+
==== Commit Body Presence
|
625
461
|
|
626
462
|
[options="header"]
|
627
463
|
|===
|
@@ -634,7 +470,7 @@ Ensures a minimum number of lines are present within the commit body. Lines with
|
|
634
470
|
|
635
471
|
Automatically ignores _fixup!_ commits as they are not meant to have bodies.
|
636
472
|
|
637
|
-
|
473
|
+
==== Commit Body Single Bullet
|
638
474
|
|
639
475
|
[options="header"]
|
640
476
|
|===
|
@@ -656,7 +492,7 @@ Pellentque morbi-trist sentus et netus et malesuada fames ac turpis egestas. Ves
|
|
656
492
|
quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu_libero sit amet quam.
|
657
493
|
....
|
658
494
|
|
659
|
-
|
495
|
+
==== Commit Body Tracker Shorthand
|
660
496
|
|
661
497
|
[options="header"]
|
662
498
|
|===
|
@@ -681,7 +517,7 @@ Instead of using tracker shorthand syntax, take the time to write a short summar
|
|
681
517
|
commit was made. Doing this will make it easier to understand _why_ the commit was made, keeps the
|
682
518
|
commit self-contained, and makes learning about/debugging the commit faster.
|
683
519
|
|
684
|
-
|
520
|
+
==== Commit Subject Length
|
685
521
|
|
686
522
|
[options="header"]
|
687
523
|
|===
|
@@ -696,7 +532,7 @@ wordy or suffer being word wrapped.
|
|
696
532
|
|
697
533
|
Automatically ignores _fixup!_ or _squash!_ commit prefixes when calculating subject length.
|
698
534
|
|
699
|
-
|
535
|
+
==== Commit Subject Prefix
|
700
536
|
|
701
537
|
[options="header"]
|
702
538
|
|===
|
@@ -744,7 +580,7 @@ tip below.
|
|
744
580
|
💡 This analyzer automatically ignores _amend!_, _fixup!_, or _squash!_ commit prefixes when used as
|
745
581
|
a Git Hook in order to not disturb interactive rebase workflows.
|
746
582
|
|
747
|
-
|
583
|
+
==== Commit Subject Suffix
|
748
584
|
|
749
585
|
[options="header"]
|
750
586
|
|===
|
@@ -757,7 +593,7 @@ the use of punctuation. This is handy when coupled with a tool, like
|
|
757
593
|
link:https://www.alchemists.io/projects/milestoner[Milestoner], which automates project milestone
|
758
594
|
releases.
|
759
595
|
|
760
|
-
|
596
|
+
==== Commit Trailer Collaborator Capitalization
|
761
597
|
|
762
598
|
[options="header"]
|
763
599
|
|===
|
@@ -775,7 +611,7 @@ shepherd derrial book
|
|
775
611
|
Shepherd Derrial Book
|
776
612
|
....
|
777
613
|
|
778
|
-
|
614
|
+
==== Commit Trailer Collaborator Duplication
|
779
615
|
|
780
616
|
[options="header"]
|
781
617
|
|===
|
@@ -795,7 +631,7 @@ Co-Authored-By: Malcolm Reynolds <malcolm@firefly.com>
|
|
795
631
|
Co-Authored-By: Shepherd Derrial Book <shepherd@firefly.com>
|
796
632
|
....
|
797
633
|
|
798
|
-
|
634
|
+
==== Commit Trailer Collaborator Email
|
799
635
|
|
800
636
|
[options="header"]
|
801
637
|
|===
|
@@ -813,7 +649,7 @@ Co-Authored-By: River Tam <invalid>
|
|
813
649
|
Co-Authored-By: River Tam <river@firefly.com>
|
814
650
|
....
|
815
651
|
|
816
|
-
|
652
|
+
==== Commit Trailer Collaborator Key
|
817
653
|
|
818
654
|
[options="header"]
|
819
655
|
|===
|
@@ -831,7 +667,7 @@ Co-authored-by: River Tam <river@firefly.com>
|
|
831
667
|
Co-Authored-By: River Tam <river@firefly.com>
|
832
668
|
....
|
833
669
|
|
834
|
-
|
670
|
+
==== Commit Trailer Collaborator Name
|
835
671
|
|
836
672
|
[options="header"]
|
837
673
|
|===
|
@@ -849,6 +685,172 @@ Co-Authored-By: River <river@firefly.com>
|
|
849
685
|
Co-Authored-By: River Tam <river@firefly.com>
|
850
686
|
....
|
851
687
|
|
688
|
+
=== Git
|
689
|
+
|
690
|
+
==== Default Branch
|
691
|
+
|
692
|
+
Your default branch configuration is respected no matter if it is set globally or locally. If the
|
693
|
+
default branch is _not set_ then Git Lint will fall back to `master` for backwards compatibility.
|
694
|
+
When the next major version is released, the default branch fallback will change from `master` to
|
695
|
+
`main`. You can set your default branch at any time by running the following from the command line:
|
696
|
+
|
697
|
+
[source,bash]
|
698
|
+
----
|
699
|
+
git config --add init.defaultBranch main
|
700
|
+
----
|
701
|
+
|
702
|
+
💡 When setting your default branch, ensure you use a consistent Git configuration across all of
|
703
|
+
your environments.
|
704
|
+
|
705
|
+
==== Hooks
|
706
|
+
|
707
|
+
This gem supports link:https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks[Git Hooks].
|
708
|
+
|
709
|
+
It is _highly recommended_ you manage Git Hooks as global scripts as it'll reduce project
|
710
|
+
maintenance costs for you. To configure global Git Hooks, add the following to your
|
711
|
+
`$HOME/.gitconfig`:
|
712
|
+
|
713
|
+
....
|
714
|
+
[core]
|
715
|
+
hooksPath = ~/.git_template/hooks
|
716
|
+
....
|
717
|
+
|
718
|
+
Then you can customize Git Hooks for all of your projects.
|
719
|
+
link:https://github.com/bkuhlmann/dotfiles/tree/main/home_files/.config/git/hooks[Check out these
|
720
|
+
examples].
|
721
|
+
|
722
|
+
If a global configuration is not desired, you can add Git Hooks at a per project level by editing
|
723
|
+
any of the scripts within the `.git/hooks` directory of the repository.
|
724
|
+
|
725
|
+
===== Commit Message
|
726
|
+
|
727
|
+
The _commit-msg_ hook -- which is the best way to use this gem as a Git Hook -- is provided as a
|
728
|
+
`--hook` option. Usage:
|
729
|
+
|
730
|
+
[source,bash]
|
731
|
+
----
|
732
|
+
git-lint --hook PATH
|
733
|
+
----
|
734
|
+
|
735
|
+
As shown above, the `--hook` command accepts a file path (i.e. `.git/COMMIT_EDITMSG`) which
|
736
|
+
is provided to you by Git within the `.git/hooks/commit-msg` script. Here is a working example of
|
737
|
+
what that script might look like:
|
738
|
+
|
739
|
+
[source,bash]
|
740
|
+
----
|
741
|
+
#! /usr/bin/env bash
|
742
|
+
|
743
|
+
set -o nounset
|
744
|
+
set -o errexit
|
745
|
+
set -o pipefail
|
746
|
+
IFS=$'\n\t'
|
747
|
+
|
748
|
+
if ! command -v git-lint > /dev/null; then
|
749
|
+
printf "%s\n" "[git]: Git Lint not found. To install, run: gem install git-lint."
|
750
|
+
exit 1
|
751
|
+
fi
|
752
|
+
|
753
|
+
git-lint --hook "${BASH_ARGV[0]}"
|
754
|
+
----
|
755
|
+
|
756
|
+
Whenever you attempt to add a commit, Git Lint will check your commit for issues prior to saving it.
|
757
|
+
|
758
|
+
===== Post Commit
|
759
|
+
|
760
|
+
The _post-commit_ hook is possible via the `--analyze` command. Usage:
|
761
|
+
|
762
|
+
[source,bash]
|
763
|
+
----
|
764
|
+
git-lint --analyze --shas SHA
|
765
|
+
----
|
766
|
+
|
767
|
+
The _post-commit_ hook can be used multiple ways but, generally, you'll want to check the last
|
768
|
+
commit made. Here is a working example which can be used as a `.git/hooks/post-commit` script:
|
769
|
+
|
770
|
+
[source,bash]
|
771
|
+
----
|
772
|
+
#! /usr/bin/env bash
|
773
|
+
|
774
|
+
set -o nounset
|
775
|
+
set -o errexit
|
776
|
+
set -o pipefail
|
777
|
+
IFS=$'\n\t'
|
778
|
+
|
779
|
+
if ! command -v git-lint > /dev/null; then
|
780
|
+
printf "%s\n" "[git]: Git Lint not found. To install, run: gem install git-lint."
|
781
|
+
exit 1
|
782
|
+
fi
|
783
|
+
|
784
|
+
git-lint --analyze --shas $(git log --pretty=format:%H -1)
|
785
|
+
----
|
786
|
+
|
787
|
+
Whenever a commit has been saved, this script will run Git Lint to check for issues.
|
788
|
+
|
789
|
+
=== Rake
|
790
|
+
|
791
|
+
This gem provides optional Rake tasks. They can be added to your project by adding the following
|
792
|
+
requirement to the top of your `Rakefile`:
|
793
|
+
|
794
|
+
[source,ruby]
|
795
|
+
----
|
796
|
+
require "git/lint/rake/setup"
|
797
|
+
----
|
798
|
+
|
799
|
+
Now, when running `bundle exec rake -T`, you'll see `git_lint` included in the list.
|
800
|
+
|
801
|
+
If you need a concrete example, check out the
|
802
|
+
link:https://github.com/bkuhlmann/git-lint/blob/main/Rakefile[Rakefile] of this project for details.
|
803
|
+
|
804
|
+
=== Continuous Integration (CI)
|
805
|
+
|
806
|
+
This gem automatically configures itself for known CI build servers (see below for details). If you
|
807
|
+
have a build server that is not listed, please log an issue or provide an implementation with
|
808
|
+
support.
|
809
|
+
|
810
|
+
Calculation of commits is done by reviewing all commits made on the feature branch since branching
|
811
|
+
from `main`.
|
812
|
+
|
813
|
+
==== link:https://circleci.com[Circle CI]
|
814
|
+
|
815
|
+
Detection and configuration happens automatically by checking the `CIRCLECI` environment variable.
|
816
|
+
No additional setup required!
|
817
|
+
|
818
|
+
==== link:https://docs.github.com/en/free-pro-team@latest/actions[GitHub Actions]
|
819
|
+
|
820
|
+
Detection happens automatically by checking the `GITHUB_ACTIONS` environment variable as supplied by
|
821
|
+
the GitHub environment. The only configuration required is to add a `.github/workflows/git_lint.yml`
|
822
|
+
to your repository with the following contents:
|
823
|
+
|
824
|
+
[source,yaml]
|
825
|
+
----
|
826
|
+
name: Git Lint
|
827
|
+
|
828
|
+
on: pull_request
|
829
|
+
|
830
|
+
jobs:
|
831
|
+
run:
|
832
|
+
runs-on: ubuntu-latest
|
833
|
+
container:
|
834
|
+
image: ruby:latest
|
835
|
+
steps:
|
836
|
+
- name: Checkout
|
837
|
+
uses: actions/checkout@v2
|
838
|
+
with:
|
839
|
+
fetch-depth: '0'
|
840
|
+
ref: ${{github.head_ref}}
|
841
|
+
- name: Install
|
842
|
+
run: gem install git-lint
|
843
|
+
- name: Analyze
|
844
|
+
run: git-lint --analyze
|
845
|
+
----
|
846
|
+
|
847
|
+
The above will ensure Git Lint runs as an additional check on each Pull Request.
|
848
|
+
|
849
|
+
==== link:https://www.netlify.com[Netlify CI]
|
850
|
+
|
851
|
+
Detection and configuration happens automatically by checking the `NETLIFY` environment variable. No
|
852
|
+
additional setup required!
|
853
|
+
|
852
854
|
== Style Guide
|
853
855
|
|
854
856
|
In addition to what is described above and automated for you, the following style guide is also
|
@@ -966,7 +968,7 @@ To contribute, run:
|
|
966
968
|
|
967
969
|
[source,bash]
|
968
970
|
----
|
969
|
-
git clone https://github.com/bkuhlmann/git-lint
|
971
|
+
git clone https://github.com/bkuhlmann/git-lint
|
970
972
|
cd git-lint
|
971
973
|
bin/setup
|
972
974
|
----
|
data/git-lint.gemspec
CHANGED
@@ -2,7 +2,7 @@
|
|
2
2
|
|
3
3
|
Gem::Specification.new do |spec|
|
4
4
|
spec.name = "git-lint"
|
5
|
-
spec.version = "4.
|
5
|
+
spec.version = "4.6.0"
|
6
6
|
spec.authors = ["Brooke Kuhlmann"]
|
7
7
|
spec.email = ["brooke@alchemists.io"]
|
8
8
|
spec.homepage = "https://www.alchemists.io/projects/git-lint"
|
@@ -23,14 +23,14 @@ Gem::Specification.new do |spec|
|
|
23
23
|
spec.cert_chain = [Gem.default_cert_path]
|
24
24
|
|
25
25
|
spec.required_ruby_version = "~> 3.1"
|
26
|
-
spec.add_dependency "
|
27
|
-
spec.add_dependency "
|
28
|
-
spec.add_dependency "
|
29
|
-
spec.add_dependency "
|
26
|
+
spec.add_dependency "cogger", "~> 0.4"
|
27
|
+
spec.add_dependency "dry-container", "~> 0.11"
|
28
|
+
spec.add_dependency "git_plus", "~> 1.7"
|
29
|
+
spec.add_dependency "infusible", "~> 0.2"
|
30
30
|
spec.add_dependency "pastel", "~> 0.8"
|
31
|
-
spec.add_dependency "refinements", "~> 9.
|
32
|
-
spec.add_dependency "runcom", "~> 8.
|
33
|
-
spec.add_dependency "spek", "~> 0.
|
31
|
+
spec.add_dependency "refinements", "~> 9.7"
|
32
|
+
spec.add_dependency "runcom", "~> 8.7"
|
33
|
+
spec.add_dependency "spek", "~> 0.6"
|
34
34
|
spec.add_dependency "zeitwerk", "~> 2.6"
|
35
35
|
|
36
36
|
spec.bindir = "exe"
|
data/lib/git/lint/import.rb
CHANGED
data.tar.gz.sig
CHANGED
Binary file
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: git-lint
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 4.
|
4
|
+
version: 4.6.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Brooke Kuhlmann
|
@@ -28,64 +28,64 @@ cert_chain:
|
|
28
28
|
CxDe2+VuChj4I1nvIHdu+E6XoEVlanUPKmSg6nddhkKn2gC45Kyzh6FZqnzH/CRp
|
29
29
|
RFE=
|
30
30
|
-----END CERTIFICATE-----
|
31
|
-
date: 2022-
|
31
|
+
date: 2022-10-22 00:00:00.000000000 Z
|
32
32
|
dependencies:
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
|
-
name:
|
34
|
+
name: cogger
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|
36
36
|
requirements:
|
37
37
|
- - "~>"
|
38
38
|
- !ruby/object:Gem::Version
|
39
|
-
version: '0.
|
39
|
+
version: '0.4'
|
40
40
|
type: :runtime
|
41
41
|
prerelease: false
|
42
42
|
version_requirements: !ruby/object:Gem::Requirement
|
43
43
|
requirements:
|
44
44
|
- - "~>"
|
45
45
|
- !ruby/object:Gem::Version
|
46
|
-
version: '0.
|
46
|
+
version: '0.4'
|
47
47
|
- !ruby/object:Gem::Dependency
|
48
|
-
name:
|
48
|
+
name: dry-container
|
49
49
|
requirement: !ruby/object:Gem::Requirement
|
50
50
|
requirements:
|
51
51
|
- - "~>"
|
52
52
|
- !ruby/object:Gem::Version
|
53
|
-
version: '0.
|
53
|
+
version: '0.11'
|
54
54
|
type: :runtime
|
55
55
|
prerelease: false
|
56
56
|
version_requirements: !ruby/object:Gem::Requirement
|
57
57
|
requirements:
|
58
58
|
- - "~>"
|
59
59
|
- !ruby/object:Gem::Version
|
60
|
-
version: '0.
|
60
|
+
version: '0.11'
|
61
61
|
- !ruby/object:Gem::Dependency
|
62
|
-
name:
|
62
|
+
name: git_plus
|
63
63
|
requirement: !ruby/object:Gem::Requirement
|
64
64
|
requirements:
|
65
65
|
- - "~>"
|
66
66
|
- !ruby/object:Gem::Version
|
67
|
-
version: '
|
67
|
+
version: '1.7'
|
68
68
|
type: :runtime
|
69
69
|
prerelease: false
|
70
70
|
version_requirements: !ruby/object:Gem::Requirement
|
71
71
|
requirements:
|
72
72
|
- - "~>"
|
73
73
|
- !ruby/object:Gem::Version
|
74
|
-
version: '
|
74
|
+
version: '1.7'
|
75
75
|
- !ruby/object:Gem::Dependency
|
76
|
-
name:
|
76
|
+
name: infusible
|
77
77
|
requirement: !ruby/object:Gem::Requirement
|
78
78
|
requirements:
|
79
79
|
- - "~>"
|
80
80
|
- !ruby/object:Gem::Version
|
81
|
-
version: '
|
81
|
+
version: '0.2'
|
82
82
|
type: :runtime
|
83
83
|
prerelease: false
|
84
84
|
version_requirements: !ruby/object:Gem::Requirement
|
85
85
|
requirements:
|
86
86
|
- - "~>"
|
87
87
|
- !ruby/object:Gem::Version
|
88
|
-
version: '
|
88
|
+
version: '0.2'
|
89
89
|
- !ruby/object:Gem::Dependency
|
90
90
|
name: pastel
|
91
91
|
requirement: !ruby/object:Gem::Requirement
|
@@ -106,42 +106,42 @@ dependencies:
|
|
106
106
|
requirements:
|
107
107
|
- - "~>"
|
108
108
|
- !ruby/object:Gem::Version
|
109
|
-
version: '9.
|
109
|
+
version: '9.7'
|
110
110
|
type: :runtime
|
111
111
|
prerelease: false
|
112
112
|
version_requirements: !ruby/object:Gem::Requirement
|
113
113
|
requirements:
|
114
114
|
- - "~>"
|
115
115
|
- !ruby/object:Gem::Version
|
116
|
-
version: '9.
|
116
|
+
version: '9.7'
|
117
117
|
- !ruby/object:Gem::Dependency
|
118
118
|
name: runcom
|
119
119
|
requirement: !ruby/object:Gem::Requirement
|
120
120
|
requirements:
|
121
121
|
- - "~>"
|
122
122
|
- !ruby/object:Gem::Version
|
123
|
-
version: '8.
|
123
|
+
version: '8.7'
|
124
124
|
type: :runtime
|
125
125
|
prerelease: false
|
126
126
|
version_requirements: !ruby/object:Gem::Requirement
|
127
127
|
requirements:
|
128
128
|
- - "~>"
|
129
129
|
- !ruby/object:Gem::Version
|
130
|
-
version: '8.
|
130
|
+
version: '8.7'
|
131
131
|
- !ruby/object:Gem::Dependency
|
132
132
|
name: spek
|
133
133
|
requirement: !ruby/object:Gem::Requirement
|
134
134
|
requirements:
|
135
135
|
- - "~>"
|
136
136
|
- !ruby/object:Gem::Version
|
137
|
-
version: '0.
|
137
|
+
version: '0.6'
|
138
138
|
type: :runtime
|
139
139
|
prerelease: false
|
140
140
|
version_requirements: !ruby/object:Gem::Requirement
|
141
141
|
requirements:
|
142
142
|
- - "~>"
|
143
143
|
- !ruby/object:Gem::Version
|
144
|
-
version: '0.
|
144
|
+
version: '0.6'
|
145
145
|
- !ruby/object:Gem::Dependency
|
146
146
|
name: zeitwerk
|
147
147
|
requirement: !ruby/object:Gem::Requirement
|
@@ -260,7 +260,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
260
260
|
- !ruby/object:Gem::Version
|
261
261
|
version: '0'
|
262
262
|
requirements: []
|
263
|
-
rubygems_version: 3.3.
|
263
|
+
rubygems_version: 3.3.24
|
264
264
|
signing_key:
|
265
265
|
specification_version: 4
|
266
266
|
summary: A command line interface for linting Git commits.
|
metadata.gz.sig
CHANGED
Binary file
|