PowerShell/docs/list-pull-requests.md
2024-11-08 12:38:20 +01:00

87 lines
2.6 KiB
Markdown

The *list-pull-requests.ps1* Script
===========================
This PowerShell script lists all pull requests for a Git repository.
Parameters
----------
```powershell
/home/markus/Repos/PowerShell/scripts/list-pull-requests.ps1 [[-RepoDir] <String>] [<CommonParameters>]
-RepoDir <String>
Specifies the file path to the local Git repository (default is working directory).
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> ./list-pull-requests.ps1 C:\MyRepo
```
Notes
-----
Author: Markus Fleschutz | License: CC0
Related Links
-------------
https://github.com/fleschutz/PowerShell
Script Content
--------------
```powershell
<#
.SYNOPSIS
Lists all pull requests
.DESCRIPTION
This PowerShell script lists all pull requests for a Git repository.
.PARAMETER RepoDir
Specifies the file path to the local Git repository (default is working directory).
.EXAMPLE
PS> ./list-pull-requests.ps1 C:\MyRepo
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
param([string]$RepoDir = "$PWD")
try {
Write-Progress "(1/3) Searching for Git executable... "
$null = (git --version)
if ($lastExitCode -ne "0") { throw "Can't execute 'git' - make sure Git is installed and available" }
Write-Progress "(2/3) Checking local repository..."
if (!(Test-Path "$RepoDir" -pathType container)) { throw "Can't access folder: $RepoDir" }
$RepoDirName = (Get-Item "$RepoDir").Name
Write-Progress "(3/3) Fetching latest updates..."
& git -C "$RepoDir" fetch --all --force --quiet
if ($lastExitCode -ne "0") { throw "'git fetch --all' failed with exit code $lastExitCode" }
Write-Progress -completed "Done."
" "
"Commit ID Reference"
"--------- ---------"
& git -C "$RepoDir" ls-remote origin 'pull/*/head'
if ($lastExitCode -ne "0") { throw "'git ls-remote' failed with exit code $lastExitCode" }
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-pull-requests.ps1 as of 11/08/2024 12:37:53)*