From 8969925d51f36e83ff457d0dbfc47e056367f57b Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Wed, 6 Nov 2024 15:06:11 +0100 Subject: [PATCH 1/2] Update Get-GitHubAppInstallationAccessToken to take pipeline input from Get-GitHubAppInstallation --- src/functions/public/Actions/Stop-GitHubWorkflowRun.ps1 | 1 - .../public/Apps/Get-GitHubAppInstallationAccessToken.ps1 | 9 +++++++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/src/functions/public/Actions/Stop-GitHubWorkflowRun.ps1 b/src/functions/public/Actions/Stop-GitHubWorkflowRun.ps1 index ba014cc3e..0d42b6a83 100644 --- a/src/functions/public/Actions/Stop-GitHubWorkflowRun.ps1 +++ b/src/functions/public/Actions/Stop-GitHubWorkflowRun.ps1 @@ -42,5 +42,4 @@ Write-Output $_.Response } } - } diff --git a/src/functions/public/Apps/Get-GitHubAppInstallationAccessToken.ps1 b/src/functions/public/Apps/Get-GitHubAppInstallationAccessToken.ps1 index 058a26e9b..32c47bf07 100644 --- a/src/functions/public/Apps/Get-GitHubAppInstallationAccessToken.ps1 +++ b/src/functions/public/Apps/Get-GitHubAppInstallationAccessToken.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubAppInstallationAccessToken { +filter Get-GitHubAppInstallationAccessToken { <# .SYNOPSIS Create an installation access token for an app @@ -39,7 +39,12 @@ param ( # The unique identifier of the installation. # Example: '12345678' - [Parameter(Mandatory)] + [Parameter( + Mandatory, + ValueFromPipeline, + ValueFromPipelineByPropertyName + )] + [Alias('ID')] [string] $InstallationID ) From 6822a517053b267367a96630f63f967d383236f3 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Wed, 6 Nov 2024 15:11:48 +0100 Subject: [PATCH 2/2] Rename function to New-* instead of Get-* aligning with the post method --- ...> New-GitHubAppInstallationAccessToken.ps1} | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) rename src/functions/public/Apps/{Get-GitHubAppInstallationAccessToken.ps1 => New-GitHubAppInstallationAccessToken.ps1} (81%) diff --git a/src/functions/public/Apps/Get-GitHubAppInstallationAccessToken.ps1 b/src/functions/public/Apps/New-GitHubAppInstallationAccessToken.ps1 similarity index 81% rename from src/functions/public/Apps/Get-GitHubAppInstallationAccessToken.ps1 rename to src/functions/public/Apps/New-GitHubAppInstallationAccessToken.ps1 index 32c47bf07..5fa32da7e 100644 --- a/src/functions/public/Apps/Get-GitHubAppInstallationAccessToken.ps1 +++ b/src/functions/public/Apps/New-GitHubAppInstallationAccessToken.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubAppInstallationAccessToken { +filter New-GitHubAppInstallationAccessToken { <# .SYNOPSIS Create an installation access token for an app @@ -28,13 +28,23 @@ to access this endpoint. .EXAMPLE - Get-GitHubAppInstallationAccessToken -InstallationID 12345678 + New-GitHubAppInstallationAccessToken -InstallationID 12345678 - Gets an installation access token for the installation with the ID `12345678`. + Creates an installation access token for the installation with the ID `12345678`. + + .EXAMPLE + Connect-GitHub -ClientID $ClientID -PrivateKey $PrivateKey -Verbose + Get-GitHubAppInstallation | New-GitHubAppInstallationAccessToken + + Gets the GitHub App installations and creates an installation access token for each installation. .NOTES [Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app) #> + [Diagnostics.CodeAnalysis.SuppressMessageAttribute( + 'PSUseShouldProcessForStateChangingFunctions', '', + Justification = 'No state is changed.' + )] [CmdletBinding()] param ( # The unique identifier of the installation. @@ -45,7 +55,7 @@ ValueFromPipelineByPropertyName )] [Alias('ID')] - [string] $InstallationID + [int] $InstallationID ) $inputObject = @{