mirror of
https://github.com/fleschutz/PowerShell.git
synced 2025-08-15 15:22:44 +02:00
Updated the Markdown manuals
This commit is contained in:
85
docs/check-repos.md
Normal file
85
docs/check-repos.md
Normal file
@ -0,0 +1,85 @@
|
||||
*check-repos.ps1*
|
||||
================
|
||||
|
||||
This PowerShell script checks all Git repositories in a folder.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
```powershell
|
||||
PS> ./check-repos.ps1 [[-parentDir] <String>] [<CommonParameters>]
|
||||
|
||||
-parentDir <String>
|
||||
Specifies the path to the parent folder
|
||||
|
||||
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
|
||||
-------
|
||||
```powershell
|
||||
PS> ./check-repos.ps1 C:\MyRepos
|
||||
|
||||
```
|
||||
|
||||
Notes
|
||||
-----
|
||||
Author: Markus Fleschutz | License: CC0
|
||||
|
||||
Related Links
|
||||
-------------
|
||||
https://github.com/fleschutz/PowerShell
|
||||
|
||||
Script Content
|
||||
--------------
|
||||
```powershell
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Checks Git repositories
|
||||
.DESCRIPTION
|
||||
This PowerShell script checks all Git repositories in a folder.
|
||||
.PARAMETER parentDir
|
||||
Specifies the path to the parent folder
|
||||
.EXAMPLE
|
||||
PS> ./check-repos.ps1 C:\MyRepos
|
||||
.LINK
|
||||
https://github.com/fleschutz/PowerShell
|
||||
.NOTES
|
||||
Author: Markus Fleschutz | License: CC0
|
||||
#>
|
||||
|
||||
param([string]$parentDir = "$PWD")
|
||||
|
||||
try {
|
||||
$stopWatch = [system.diagnostics.stopwatch]::startNew()
|
||||
|
||||
$parentDirName = (Get-Item "$parentDir").Name
|
||||
"⏳ Step 1 - Checking parent folder 📂$parentDirName..."
|
||||
if (-not(Test-Path "$parentDir" -pathType container)) { throw "Can't access folder: $parentDir" }
|
||||
$folders = (Get-ChildItem "$parentDir" -attributes Directory)
|
||||
$numFolders = $folders.Count
|
||||
"Found $numFolders subfolders."
|
||||
|
||||
[int]$Step = 1
|
||||
foreach ($folder in $folders) {
|
||||
& "$PSScriptRoot/check-repo.ps1" "$folder"
|
||||
$Step++
|
||||
}
|
||||
|
||||
[int]$elapsed = $stopWatch.Elapsed.TotalSeconds
|
||||
"✔️ Checked $numFolders Git repos at 📂$parentDirName 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 check-repos.ps1 as of 01/03/2024 12:10:44)*
|
Reference in New Issue
Block a user