PowerShell/Docs/new-tag.md

99 lines
2.7 KiB
Markdown
Raw Normal View History

2022-12-04 10:40:18 +01:00
## The *new-tag.ps1* Script
2021-11-08 21:36:42 +01:00
2022-02-10 09:01:07 +01:00
This PowerShell script creates a new tag in a Git repository.
2021-11-08 21:36:42 +01:00
## Parameters
```powershell
2023-05-26 12:20:18 +02:00
/home/mf/Repos/PowerShell/Scripts/new-tag.ps1 [[-TagName] <String>] [[-RepoDir] <String>] [<CommonParameters>]
2021-11-08 21:36:42 +01:00
-TagName <String>
Specifies the new tag name
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-RepoDir <String>
Specifies the path to the Git repository
Required? false
Position? 2
Default value "$PWD"
Accept pipeline input? false
Accept wildcard characters? false
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
## Example
```powershell
PS> ./create-tag v1.7
```
## Notes
2022-11-17 19:46:02 +01:00
Author: Markus Fleschutz | License: CC0
2021-11-08 21:36:42 +01:00
## Related Links
https://github.com/fleschutz/PowerShell
2022-11-17 20:02:26 +01:00
## Source Code
2022-11-17 20:05:34 +01:00
```powershell
2022-11-17 20:02:26 +01:00
<#
.SYNOPSIS
Creates a new tag in a Git repository
.DESCRIPTION
This PowerShell script creates a new tag in a Git repository.
.PARAMETER TagName
Specifies the new tag name
.PARAMETER RepoDir
Specifies the path to the Git repository
.EXAMPLE
PS> ./create-tag v1.7
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
param([string]$TagName = "", [string]$RepoDir = "$PWD")
try {
if ($TagName -eq "") { $TagName = read-host "Enter new tag name" }
$StopWatch = [system.diagnostics.stopwatch]::startNew()
if (-not(test-path "$RepoDir" -pathType container)) { throw "Can't access directory: $RepoDir" }
set-location "$RepoDir"
$Null = (git --version)
if ($lastExitCode -ne "0") { throw "Can't execute 'git' - make sure Git is installed and available" }
$Result = (git status)
if ($lastExitCode -ne "0") { throw "'git status' failed in $RepoDir" }
if ("$Result" -notmatch "nothing to commit, working tree clean") { throw "Repository is NOT clean: $Result" }
& "$PSScriptRoot/fetch-repo.ps1"
if ($lastExitCode -ne "0") { throw "Script 'fetch-repo.ps1' failed" }
& git tag "$TagName"
if ($lastExitCode -ne "0") { throw "Error: 'git tag $TagName' failed!" }
& git push origin "$TagName"
if ($lastExitCode -ne "0") { throw "Error: 'git push origin $TagName' failed!" }
[int]$Elapsed = $StopWatch.Elapsed.TotalSeconds
"✔️ created new tag '$TagName' in $Elapsed sec"
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}
2022-11-17 20:05:34 +01:00
```
2022-11-17 20:02:26 +01:00
2021-11-08 21:36:42 +01:00
*Generated by convert-ps2md.ps1 using the comment-based help of new-tag.ps1*