extern/PowerShell
1
0
Fork 0
mirror of https://github.com/fleschutz/PowerShell.git synced 2025-08-15 15:22:44 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated the Markdown manuals

Browse Source
This commit is contained in:
Markus Fleschutz
2024-05-19 10:25:56 +02:00
parent c24030c909
commit 439fbf5bfa
621 changed files with 2430 additions and 1289 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
docs/new-branch.md
View File

@ -1,7 +1,7 @@
Script: *new-branch.ps1*
========================
This PowerShell script creates a new Git branch in a local repository and switches to it.
This PowerShell script creates a new branch in a local Git repository and switches to it.
Parameters
----------
@ -9,7 +9,7 @@ Parameters
PS> ./new-branch.ps1 [[-newBranch] <String>] [[-pathToRepo] <String>] [<CommonParameters>]
-newBranch <String>
Specifies the new Git branch name (check the allowed characters)
Specifies the new Git branch name
Required? false
Position? 1
@ -18,7 +18,7 @@ PS> ./new-branch.ps1 [[-newBranch] <String>] [[-pathToRepo] <String>] [<CommonPa
Accept wildcard characters? false
-pathToRepo <String>
Specifies the file path to the local repository (current working directory per default)
Specifies the file path to the local Git repository (current working directory per default)
Required? false
Position? 2
@ -36,12 +36,12 @@ Example
```powershell
PS> ./new-branch.ps1 test123 C:\Repos\rust
⏳ (1/6) Searching for Git executable... git version 2.42.0.windows.2
⏳ (2/6) Checking Git repository...
⏳ (3/6) Fetching updates...
⏳ (2/6) Checking local repository... 📂C:\Repos\rust
⏳ (3/6) Fetching remote updates...
⏳ (4/6) Creating new branch...
⏳ (5/6) Pushing updates...
⏳ (6/6) Updating submodules...
✔️ Created branch 'test123' in 📂rust repository in 18 sec (based on 'main')
✔️ Created branch 'test123' in repo 📂rust (based on 'main', took 18s)
```
@ -58,22 +58,22 @@ Script Content
```powershell
<#
.SYNOPSIS
Creates a new branch
Creates a new Git branch
.DESCRIPTION
This PowerShell script creates a new Git branch in a local repository and switches to it.
This PowerShell script creates a new branch in a local Git repository and switches to it.
.PARAMETER newBranch
Specifies the new Git branch name (check the allowed characters)
Specifies the new Git branch name
.PARAMETER pathToRepo
Specifies the file path to the local repository (current working directory per default)
Specifies the file path to the local Git repository (current working directory per default)
.EXAMPLE
PS> ./new-branch.ps1 test123 C:\Repos\rust
⏳ (1/6) Searching for Git executable... git version 2.42.0.windows.2
⏳ (2/6) Checking Git repository...
⏳ (3/6) Fetching updates...
⏳ (2/6) Checking local repository... 📂C:\Repos\rust
⏳ (3/6) Fetching remote updates...
⏳ (4/6) Creating new branch...
⏳ (5/6) Pushing updates...
⏳ (6/6) Updating submodules...
✔️ Created branch 'test123' in 📂rust repository in 18 sec (based on 'main')
✔️ Created branch 'test123' in repo 📂rust (based on 'main', took 18s)
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
@ -91,11 +91,13 @@ try {
& git --version
if ($lastExitCode -ne "0") { throw "Can't execute 'git' - make sure Git is installed and available" }
Write-Host "⏳ (2/6) Checking Git repository..."
if (-not(Test-Path "$pathToRepo" -pathType container)) { throw "Can't access directory: $pathToRepo" }
Write-Host "⏳ (2/6) Checking local repository... 📂$pathToRepo"
if (-not(Test-Path "$pathToRepo" -pathType container)) { throw "Can't access repo folder: $pathToRepo" }
$result = (git -C "$pathToRepo" status)
if ($lastExitCode -ne "0") { throw "'git status' in $pathToRepo failed with exit code $lastExitCode" }
$repoName = (Get-Item "$pathToRepo").Name
"⏳ (3/6) Fetching updates..."
"⏳ (3/6) Fetching remote updates..."
& git -C "$pathToRepo" fetch --all --recurse-submodules --prune --prune-tags --force
if ($lastExitCode -ne "0") { throw "'git fetch' failed with exit code $lastExitCode" }
@ -115,7 +117,7 @@ try {
if ($lastExitCode -ne "0") { throw "'git submodule update' failed with exit code $lastExitCode" }
[int]$elapsed = $stopWatch.Elapsed.TotalSeconds
"✔️ Created branch '$newBranch' in 📂$repoName repository in $elapsed sec (based on '$currentBranch')"
"✔️ Created branch '$newBranch' in repo 📂$repoName (based on '$currentBranch', took $($elapsed)s)"
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
@ -123,4 +125,4 @@ try {
}
```
*(generated by convert-ps2md.ps1 using the comment-based help of new-branch.ps1 as of 03/27/2024 17:36:29)*
*(generated by convert-ps2md.ps1 using the comment-based help of new-branch.ps1 as of 05/19/2024 10:25:23)*