Git Mailmap Linter

Description

Small, easy to use, easy to install tool to lint your git mailmap

Verifications

• Mailmap file (.mailmap) must exist
• Mailmap must be sorted
• All authors in git history must be mapped
• All authors must conform to: Name FamilyName <[email protected]>

Installation

Given you've installed Nix (https://nixos.org/nix/download.html)

Run the following command:

$ nix-env -i -f https://github.com/kamadorueda/mailmap-linter/archive/master.tar.gz

Use

Run from the root of the repository that you want to lint:

$ mailmap-linter

Use inside your CI

Use Nixos/nix as the base image for your Job: https://hub.docker.com/r/nixos/nix

Then install and use with the same commands for the local build

Example

$ mailmap-linter
  [INFO] Veryfing if .mailmap exists
  [INFO] Computing contributors
  [INFO] Reading current .mailmap
  [INFO] Veryting .mailmap format
    [INFO] Ok: Line 1: Kevin Amado <[email protected]> Kevin Amado <[email protected]>
  [INFO] Veryfing that every author is in the .mailmap
    [INFO] Veryfing: Kevin Amado <[email protected]>
  [INFO] Veryfing that .mailmap is sorted
    [INFO] OK