Last active
December 19, 2019 18:13
-
-
Save thedavecarroll/3245449f5ff893e51907f7aa13e33ebe to your computer and use it in GitHub Desktop.
A PowerShell function for reading the git log of a local repository which is returned as an array of PSCustomObjects.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
function Get-GitLog { | |
[CmdLetBinding(DefaultParameterSetName='Default')] | |
param ( | |
[Parameter(ParameterSetName='Default',ValueFromPipeline,Mandatory)] | |
[Parameter(ParameterSetName='SourceTarget',ValueFromPipeline,Mandatory)] | |
[ValidateScript({Resolve-Path -Path $_ | Test-Path})] | |
[string]$GitFolder, | |
[Parameter(ParameterSetName='SourceTarget',Mandatory)] | |
[string]$StartCommitId, | |
[Parameter(ParameterSetName='SourceTarget')] | |
[string]$EndCommitId='HEAD' | |
) | |
Push-Location | |
try { | |
Set-Location -Path $GitFolder | |
$GitCommand = Get-Command -Name git -ErrorAction Stop | |
} | |
catch { | |
$PSCmdlet.ThrowTerminatingError($_) | |
} | |
if ($StartCommitId) { | |
$GitLogCommand = '"{0}" log --oneline --format="%H`t%h`t%ai`t%an`t%ae`t%ci`t%cn`t%ce`t%G?`t%s`t%f" {1}...{2} 2>&1' -f $GitCommand.Source,$StartCommitId,$EndCommitId | |
#} elseif ($Branch) { | |
# $GitLogCommand = '"{0}" log --oneline --format="%H`t%h`t%ai`t%an`t%ae`t%ci`t%cn`t%ce`t%G?`t%s`t%f" --branches 2>&1' -f $GitCommand.Source | |
} else { | |
$GitLogCommand = '"{0}" log --oneline --format="%H`t%h`t%ai`t%an`t%ae`t%ci`t%cn`t%ce`t%G?`t%s`t%f" 2>&1' -f $GitCommand.Source | |
} | |
Write-Verbose -Message $GitLogCommand | |
$GitLog = Invoke-Expression -Command "& $GitLogCommand" -ErrorAction SilentlyContinue | |
Pop-Location | |
$GitLogFormat = 'CommitId', | |
'ShortCommitId', | |
'AuthorDate', | |
'AuthorName', | |
'AuthorEmail', | |
'CommitterDate', | |
'CommitterName', | |
'ComitterEmail', | |
@{label='CommitterSignature';expression={ | |
switch ($_.CommitterSignature) { | |
'G' { 'Valid'} | |
'B' { 'BadSignature'} | |
'U' { 'GoodSignatureUnknownValidity'} | |
'X' { 'GoodSignatureExpired'} | |
'Y' { 'GoodSignatureExpiredKey'} | |
'R' { 'GoodSignatureRevokedKey'} | |
'E' { 'MissingKey'} | |
'N' { 'NoSignature'} | |
} | |
}}, | |
'CommitMessage', | |
'SafeCommitMessage' | |
if ($GitLog[0] -notmatch 'fatal:') { | |
$GitLog | ConvertFrom-Csv -Delimiter "`t" -Header 'CommitId','ShortCommitId','AuthorDate','AuthorName','AuthorEmail','CommitterDate','CommitterName','ComitterEmail','CommitterSignature','CommitMessage','SafeCommitMessage' | Select-Object $GitLogFormat | |
} else { | |
if ($GitLog[0] -like "fatal: ambiguous argument '*...*'*") { | |
Write-Warning -Message 'Unknown revision. Please check the values for StartCommitId or EndCommitId; omit the parameters to retrieve the entire log.' | |
} else { | |
Write-Error -Category InvalidArgument -Message ($GitLog -join "`n") | |
} | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Added support for providing input via pipeline.