Functions/Get-GitTag.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
# 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 copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

function Get-GitTag{
    <#
    .SYNOPSIS
    Gets the tags in a Git repository.
 
    .DESCRIPTION
    The `Get-GitTag` function returns a list of all the tags in a Git repository.
 
    To get a specific tag, pass its name to the `Name` parameter. Wildcard characters are supported in the tag name. Only tags that match the wildcard pattern will be returned.
 
    .EXAMPLE
    Get-GitTag
 
    Demonstrates how to get all the tags in a repository.
 
    .EXAMPLE
    Get-GitTag -Name 'LastSuccessfulBuild'
 
    Demonstrates how to return a specific tag. If no tag matches, then `$null` is returned.
 
    .EXAMPLE
    Get-GitTag -Name '13.8.*' -RepoRoot 'C:\Projects\LibGit2'
 
    Demonstrates how to return all tags that match a wildcard in the given repository.'
    #>



   [CmdletBinding()]
   [OutputType([LibGit2.Automation.TagInfo])]
    param(
        [string]
        # Specifies which git repository to check. Defaults to the current directory.
        $RepoRoot = (Get-Location).ProviderPath,

        [string]
        # The name of the tag to return. Wildcards accepted.
        $Name
    )

    Set-StrictMode -Version 'Latest'

    $repo = Find-GitRepository -Path $RepoRoot -Verify
    if( -not $repo )
    {
        return
    }

    try
    {
        $repo.Tags | ForEach-Object {
            New-Object LibGit2.Automation.TagInfo $_
            } |
            Where-Object {
                if( $PSBoundParameters.ContainsKey('Name') )
                {
                    return $_.Name -like $Name
                }
                return $true
            }
    }
    finally
    {
        $repo.Dispose()
    }
}