Functions/Send-GitObject.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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
# 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 Send-GitObject {
    <#
    .SYNOPSIS
    Sends Git refs and object to a remote repository.

    .DESCRIPTION
    The `Send-GitObject` functions sends objects from a local repository to a remote repository. You specify what refs and objects to send with the `Revision` parameter.

    This command implements the `git push` command.

    .EXAMPLE
    Send-GitObject -Revision 'refs/heads/master'

    Demonstrates how to push the commits on a specific branch to the default remote repository.

    .EXAMPLE
    Send-GitObject -Revision 'refs/heads/master' -RemoteName 'upstream'

    Demonstrates how to push an object (in this case, the master branch) to a specific remote repository, in this case the remote named "upstream".

    .EXAMPLE
    Send-GitObject -Revision 'refs/tags/4.45.6'

    Demonstrates how to push a tag to the default remote repository.

    .EXAMPLE
    Send-GitObject -Tags

    Demonstrates how to push all tags to the default remote repository.
    #>

    [CmdletBinding()]
    [OutputType([LibGit2Sharp.Branch], ParameterSetName = 'BranchObject')] # returns input to support piping
    param(
        [Parameter(Mandatory, ParameterSetName = 'BranchObject', ValueFromPipeline)]
        [LibGit2Sharp.Branch] $BranchObject,

        [Parameter(ParameterSetName = 'BranchObject')]
        [Alias('u')]
        [switch] $SetUpstream,

        # The refs that should be pushed to the remote repository.
        [Parameter(Mandatory, ParameterSetName = 'ByRefSpec')]
        [string[]] $RefSpec,

        # Push all tags to the remote repository.
        [Parameter(Mandatory, ParameterSetname = 'Tags')]
        [Switch] $Tags,

        # The name of the remote repository to send the changes to. The default is the branch's upstream or "origin".
        [Parameter(Position = 0)]
        [string] $Remote,

        # Usually, the command refuses to update a remote ref that is not an ancestor of the local ref used to overwrite it.
        # This flag disables this check by prefixing all refspecs with "+".
        [switch] $Force,

        # The path to the local repository from which to push changes. Defaults to the current directory.
        [string] $RepoRoot = (Get-Location).ProviderPath,

        # The credentials to use to connect to the source repository.
        [pscredential] $Credential
    )

    process {
        Set-StrictMode -Version 'Latest'
        Use-CallerPreference -Cmdlet $PSCmdlet -SessionState $ExecutionContext.SessionState

        $repo = Find-GitRepository -Path $RepoRoot -Verify

        $cancel = $false

        $pushOptions = [LibGit2Sharp.PushOptions]::new()
        $pushOptions.OnPushTransferProgress = {
            param([int]$current, [int]$total, [long]$bytes)
            if ($ProgressPreference -ne 'SilentlyContinue' -and $total -ne 0) {
                Write-Progress -Activity 'Pushing objects' -PercentComplete (($current / $total) * 100) -Status "$($bytes)B"
            }
            return -not $cancel -and -not $PSCmdlet.Stopping
        }
        # This gets called after the function already returned, leading the pwsh process to crash.
        # $pushOptions.OnPackBuilderProgress = {
        # param([LibGit2Sharp.Handlers.PackBuilderStage]$stage, [int]$current, [int]$total)
        # if ($ProgressPreference -ne 'SilentlyContinue' -and $total -ne 0) {
        # Write-Progress -Activity 'Packing objects' -PercentComplete (($current / $total) * 100) -CurrentOperation $stage
        # }
        # return -not $cancel -and -not $PSCmdlet.Stopping
        # }
        $pushOptions.OnPushStatusError = {
            param([LibGit2Sharp.PushStatusError]$PushStatusError)
            Write-Error -Message "$($PushStatusError.Reference): $($PushStatusError.Message)"
        }
        $credentialsProviderCalled = $false
        $pushOptions.CredentialsProvider = {
            param([string]$Url, [string]$UsernameForUrl, [LibGit2Sharp.SupportedCredentialTypes]$Types)
            Write-Verbose "Credentials required"
            if ($credentialsProviderCalled) {
                $Credential = Get-Credential -Title "Wrong credentials provided for $Url"
            } else {
                Set-Variable -Name credentialsProviderCalled -Value $true -Scope 1
                if (-not $Credential) {
                    $Credential = Get-Credential -Title "Authentication required for $Url"
                }
            }
            $gitCredential = [LibGit2Sharp.SecureUsernamePasswordCredentials]::new()
            $gitCredential.Username = $Credential.UserName
            $gitCredential.Password = $Credential.Password
            return $gitCredential
        }

        if (-not $Remote) {
            $Remote = if ($null -ne $BranchObject -and $BranchObject.RemoteName) {
                $BranchObject.RemoteName
            } else {
                'origin'
            }
        }

        [LibGit2Sharp.Remote]$remoteObject = $repo.Network.Remotes[$Remote]

        if (-not $remoteObject) {
            Write-Error "A remote named ""$Remote"" does not exist."
            return
        }

        if ($PSCmdlet.ParameterSetName -eq 'BranchObject') {
            $RefSpec = $BranchObject.CanonicalName
        }

        if ($Tags) {
            $RefSpec = $repo.Tags | ForEach-Object { $_.CanonicalName }
        }

        if ($Force) {
            $RefSpec = $RefSpec | ForEach-Object {
                if (-not $_.StartsWith('+')) { "+$_" } else { $_ }
            }
        }

        try {
            Write-Verbose "Pushing refspec $RefSpec of repository $RepoRoot to remote $($remoteObject.Name)"
            $repo.Network.Push($remoteObject, $RefSpec, $pushOptions) | Out-Null
            if ($SetUpstream) {
                # Setup tracking with the new remote branch.
                $repo.Branches.Update($BranchObject, {
                        param([LibGit2Sharp.BranchUpdater] $Updater)
                        $updater.Remote = $Remote
                        $updater.UpstreamBranch = $BranchObject.CanonicalName
                    }) | Out-Null;
                $BranchObject = Get-GitBranch -Name $BranchObject.CanonicalName
            }
            return $BranchObject
        } catch {
            Write-Error -ErrorRecord $_
        } finally {
            $cancel = $true
            $repo.Dispose()
        }
    }
}