Functions/Save-GitCommit.ps1
|
# 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 Save-GitCommit { <# .SYNOPSIS Commits changes to a Git repository. .DESCRIPTION The `Save-GitCommit` function commits changes to a Git repository. Those changes must be staged first with `git add` or the `PowerGit` module's `Add-GitItem` function. If there are no changes staged, nothing happens, and nothing is returned. You are required to pass a commit message with the `Message` parameter. This module is intended to be used by non-interactive repository automation scripts, so opening in an editor is not supported. Implements the `git commit` command. .OUTPUTS LibGit2Sharp.Commit .LINK Add-GitItem .EXAMPLE Save-GitCommit -Message 'Creating Save-GitCommit function.' Demonstrates how to commit staged changes in a Git repository. In this example, the repository is assumed to be in the current directory. .EXAMPLE Save-GitCommit -Message 'Creating Save-GitCommit function.' -RepoRoot 'C:\Projects\PowerGit' Demonstrates how to commit changes to a repository other than the current directory. .EXAMPLE Save-GitCommit -Message 'Creating Save-GitCommit function.' -Signature (New-GitSignature -Name 'Name' -EmailAddress 'email@example.com') Demonstrates how to set custom author metadata. In this case, the commit will be from user "Name" whose email address is "email@example.com". #> [CmdletBinding(DefaultParameterSetName = 'New')] [OutputType([LibGit2Sharp.Commit])] param( # The commit message. # Can be omitted if -Amend is passed, otherwise mandatory. [Parameter(Mandatory, ParameterSetName = 'New')] [Parameter(ParameterSetName = 'Amend')] [string] $Message, # The repository where to commit staged changes. Defaults to the current directory. [string] $RepoRoot = (Get-Location).ProviderPath, # Author metadata. If not provided, it is pulled from configuration. To create an author/signature object, # # New-GitSignature -name 'Name' -EmailAddress 'email@example.com' # [LibGit2Sharp.Signature] $Signature, [Parameter(Mandatory, ParameterSetName = 'Amend')] [switch] $Amend, [switch] $AllowEmpty ) Set-StrictMode -Version 'Latest' $repo = Find-GitRepository -Path $RepoRoot -Verify if (-not $repo) { return } try { $commitOptions = [LibGit2Sharp.CommitOptions]::new() $commitOptions.AmendPreviousCommit = $Amend $commitOptions.AllowEmptyCommit = $AllowEmpty if (-not $Signature) { $Signature = New-GitSignature -RepoRoot $RepoRoot -ErrorAction Ignore if (-not $Signature) { Write-Error -Message ('Failed to build author signature from Git configuration files. Pass an author signature to the "Signature" parameter (use the "New-GitSignature" function to create an author signature) or set author information in Git''s user-level configuration files by running these commands: git config --global user.name "GIVEN_NAME SURNAME" git config --global user.email "email@example.com" ') return } } if (-not $PSBoundParameters.ContainsKey('Message') -and $Amend) { # Implied --no-edit $Message = (Get-GitCommit HEAD).Message } $repo.Commit($Message, $Signature, $Signature, $commitOptions) } catch [LibGit2Sharp.EmptyCommitException] { $Global:Error.RemoveAt(0) Write-Warning -Message ('Nothing to commit. Git only commits changes that are staged. To stage changes, use Add-GitItem.') } catch { Write-Error -ErrorRecord $_ } } |