clone-repos.md

The clone-repos.ps1 PowerShell Script

This PowerShell script clones well-known Git repositories into a folder.

Parameters

clone-repos.ps1 [[-FolderPath] <String>] [<CommonParameters>]

-FolderPath <String>
    
    Required?                    false
    Position?                    1
    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

PS> ./clone-repos C:\Repos

Notes

Author: Markus Fleschutz | License: CC0

Related Links

https://github.com/fleschutz/PowerShell

Source Code

<# .SYNOPSIS Clones Git repositories .DESCRIPTION This PowerShell script clones well-known Git repositories into a folder. .PARAMETER folder Specifies the target folder .EXAMPLE PS> ./clone-repos C:\Repos .LINK https://github.com/fleschutz/PowerShell .NOTES Author: Markus Fleschutz | License: CC0 #>

param([string]$FolderPath = "$PWD")

try { $StopWatch = [system.diagnostics.stopwatch]::startNew()

"⏳ Step 1 - Searching for Git executable..."
& git --version
if ($lastExitCode -ne "0") { throw "Can't execute 'git' - make sure Git is installed and available" }

"⏳ Step 2 - Loading database table in Data/git-repos.csv..."
$Table = Import-CSV "$PSScriptRoot/../Data/git-repos.csv"
$NumEntries = $Table.count
"Found $NumEntries entries."

$ParentFolderName = (Get-Item "$FolderPath").Name
"⏳ Step 3 - Checking folder 📂$ParentFolderName..."
if (-not(Test-Path "$FolderPath" -pathType container)) { throw "Can't access directory: $FolderPath" }


[int]$Step = 3
[int]$Cloned = 0
[int]$Skipped = 0
foreach($Row in $Table) {
	[string]$FolderName = $Row.FolderName
	[string]$Branch = $Row.Branch
	[string]$Full = $Row.Full
	[string]$URL = $Row.URL
	$Step++

	if (test-path "$FolderPath/$FolderName" -pathType container) {
		"⏳ Step $Step/$($NumEntries + 4) - Skipping 📂$($FolderName) (exists already)..."
		$Skipped++
		continue
	}
	if ($Full -eq "yes") {
		"⏳ Step $Step/$($NumEntries + 4) - Cloning into 📂$($FolderName) ($Branch branch with full history)..."
		& git clone --branch "$Branch" --recurse-submodules "$URL" "$FolderPath/$FolderName"
		if ($lastExitCode -ne "0") { throw "'git clone --branch $Branch $URL' failed with exit code $lastExitCode" }
	} else {
		"⏳ Step $Step/$($NumEntries + 4) - Cloning into 📂$FolderName ($Branch branch only)..."
		& git clone --branch "$Branch" --single-branch --recurse-submodules "$URL" "$FolderPath/$FolderName"
		if ($lastExitCode -ne "0") { throw "'git clone --branch $Branch $URL' failed with exit code $lastExitCode" }
	}
	$Cloned++
}
[int]$Elapsed = $StopWatch.Elapsed.TotalSeconds
if ($Cloned -eq 1) {
	"✔️ $Cloned repo cloned into 📂$ParentFolderName ($Skipped skipped) in $Elapsed sec"
} else {
	"✔️ $Cloned repos cloned into 📂$ParentFolderName ($Skipped skipped) in $Elapsed sec"
}
exit 0 # success

} catch { "⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])" exit 1 }

Generated by convert-ps2md.ps1 using the comment-based help of clone-repos.ps1