mirror of
https://github.com/fleschutz/PowerShell.git
synced 2025-08-19 08:52:05 +02:00
Update the manuals in Docs/
This commit is contained in:
@@ -1,4 +1,4 @@
|
||||
## list-submodules.ps1 - Lists the submodules in a Git repository
|
||||
## The list-submodules.ps1 PowerShell Script
|
||||
|
||||
This PowerShell script lists the submodules in the given Git repository.
|
||||
|
||||
@@ -32,4 +32,43 @@ Author: Markus Fleschutz | License: CC0
|
||||
## Related Links
|
||||
https://github.com/fleschutz/PowerShell
|
||||
|
||||
## Source Code
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Lists the submodules in a Git repository
|
||||
.DESCRIPTION
|
||||
This PowerShell script lists the submodules in the given Git repository.
|
||||
.PARAMETER RepoDir
|
||||
Specifies the path to the repository (current working directory by default)
|
||||
.EXAMPLE
|
||||
PS> ./list-submodules C:\MyRepo
|
||||
.LINK
|
||||
https://github.com/fleschutz/PowerShell
|
||||
.NOTES
|
||||
Author: Markus Fleschutz | License: CC0
|
||||
#>
|
||||
|
||||
param([string]$RepoDir = "$PWD")
|
||||
|
||||
try {
|
||||
"⏳ Step 1/3: Checking requirements... "
|
||||
if (-not(test-path "$RepoDir" -pathType container)) { throw "Can't access directory: $RepoDir" }
|
||||
|
||||
& git --version
|
||||
if ($lastExitCode -ne "0") { throw "Can't execute 'git' - make sure Git is installed and available" }
|
||||
|
||||
"⏳ Step 2/3: Fetching latest updates... "
|
||||
& git -C "$RepoDir" fetch
|
||||
if ($lastExitCode -ne "0") { throw "'git fetch' failed" }
|
||||
|
||||
"⏳ Step 3/3: Listing submodules... "
|
||||
& git -C "$RepoDir" submodule
|
||||
if ($lastExitCode -ne "0") { throw "'git submodule' failed" }
|
||||
|
||||
exit 0 # success
|
||||
} catch {
|
||||
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
|
||||
exit 1
|
||||
}
|
||||
|
||||
*Generated by convert-ps2md.ps1 using the comment-based help of list-submodules.ps1*
|
||||
|
Reference in New Issue
Block a user