🩹 [Patch]: Add Get-GitHubContextInfo function to list available GitHub contexts (#229)

## Description

This pull request introduces a new PowerShell function
`Get-GitHubContextInfo`. The function is designed to list available
GitHub contexts without retrieving the context data making it better
suited to do lightweight queries about available contexts.


## Type of change

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [ ] 📖 [Docs]
- [ ] 🪲 [Fix]
- [x] 🩹 [Patch]
- [ ] ⚠️ [Security fix]
- [ ] 🚀 [Feature]
- [ ] 🌟 [Breaking change]

## Checklist

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas

Author: MariusStorhaug

src/functions/private/Auth/Context/Remove-GitHubContext.ps1

@@ -1,4 +1,4 @@
-#Requires -Modules @{ ModuleName = 'Context'; RequiredVersion = '5.0.4' }
+#Requires -Modules @{ ModuleName = 'Context'; RequiredVersion = '5.0.5' }
 
 filter Remove-GitHubContext {
     <#

src/functions/private/Auth/Context/Set-GitHubContext.ps1

@@ -1,4 +1,4 @@
-#Requires -Modules @{ ModuleName = 'Context'; RequiredVersion = '5.0.4' }
+#Requires -Modules @{ ModuleName = 'Context'; RequiredVersion = '5.0.5' }
 
 function Set-GitHubContext {
     <#

src/functions/public/Auth/Context/Get-GitHubContext.ps1

@@ -1,4 +1,4 @@
-#Requires -Modules @{ ModuleName = 'Context'; RequiredVersion = '5.0.4' }
+#Requires -Modules @{ ModuleName = 'Context'; RequiredVersion = '5.0.5' }
 
 function Get-GitHubContext {
     <#

src/functions/public/Auth/Context/Get-GitHubContextInfo.ps1

@@ -0,0 +1,56 @@
+#Requires -Modules @{ ModuleName = 'Context'; RequiredVersion = '5.0.5' }
+
+function Get-GitHubContextInfo {
+    <#
+        .SYNOPSIS
+        Lists the available GitHub contexts without getting the context data.
+
+        .DESCRIPTION
+        Lists the available GitHub contexts without getting the context data.
+
+        .EXAMPLE
+        Get-GitHubContextInfo
+
+        Gets the current GitHub context.
+
+        .EXAMPLE
+        Get-GitHubContextInfo -Name 'github.com*'
+
+        Gets the GitHub context that matches the name 'github.com*'.
+
+        .EXAMPLE
+        Get-GitHubContextInfo -Name '*/Organization/*'
+
+        Gets the GitHub context that matches the name '*/Organization/*'.
+    #>
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute(
+        'PSAvoidUsingConvertToSecureStringWithPlainText', '',
+        Justification = 'Encapsulated in a function. Never leaves as a plain text.'
+    )]
+    [OutputType([GitHubContext])]
+    [CmdletBinding(DefaultParameterSetName = '__AllParameterSets')]
+    param(
+        # The name of the context to get.
+        [Parameter()]
+        [SupportsWildcards()]
+        [string] $Name = '*'
+    )
+
+    begin {
+        $stackPath = Get-PSCallStackPath
+        Write-Debug "[$stackPath] - Start"
+        Initialize-GitHubConfig
+    }
+
+    process {
+        try {
+            Get-ContextInfo -ID "$($script:GitHub.Config.ID)/$Name"
+        } catch {
+            throw $_
+        }
+    }
+
+    end {
+        Write-Debug "[$stackPath] - End"
+    }
+}

src/functions/public/Auth/Update-GitHubUserAccessToken.ps1

@@ -1,4 +1,6 @@
-function Update-GitHubUserAccessToken {
+#Requires -Modules @{ ModuleName = 'Context'; RequiredVersion = '5.0.5' }
+
+function Update-GitHubUserAccessToken {
     <#
         .SYNOPSIS
         Updates the GitHub access token.
@@ -22,7 +24,8 @@
     [OutputType([securestring])]
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidLongLines', '', Justification = 'Long links for documentation.')]
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingWriteHost', '', Justification = 'Is the CLI part of the module.')]
-    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingConvertToSecureStringWithPlainText', '', Justification = 'The tokens are recieved as clear text. Mitigating exposure by removing variables and performing garbage collection.')]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingConvertToSecureStringWithPlainText', '',
+        Justification = 'The tokens are recieved as clear text. Mitigating exposure by removing variables and performing garbage collection.')]
     [CmdletBinding(SupportsShouldProcess)]
     param(
         # The context to run the command in. Used to get the details for the API call.

src/functions/public/Config/Get-GitHubConfig.ps1

@@ -1,4 +1,4 @@
-#Requires -Modules @{ ModuleName = 'Context'; RequiredVersion = '5.0.4' }
+#Requires -Modules @{ ModuleName = 'Context'; RequiredVersion = '5.0.5' }
 
 function Get-GitHubConfig {
     <#

src/functions/public/Config/Remove-GitHubConfig.ps1

@@ -1,4 +1,4 @@
-#Requires -Modules @{ ModuleName = 'Context'; RequiredVersion = '5.0.4' }
+#Requires -Modules @{ ModuleName = 'Context'; RequiredVersion = '5.0.5' }
 
 function Remove-GitHubConfig {
     <#

src/functions/public/Config/Set-GitHubConfig.ps1

@@ -1,4 +1,4 @@
-#Requires -Modules @{ ModuleName = 'Context'; RequiredVersion = '5.0.4' }
+#Requires -Modules @{ ModuleName = 'Context'; RequiredVersion = '5.0.5' }
 
 function Set-GitHubConfig {
     <#

tests/GitHub.Tests.ps1

@@ -62,7 +62,7 @@ Describe 'GitHub' {
                 PrivateKey = $env:TEST_APP_PRIVATE_KEY
             }
             { Connect-GitHubAccount @params } | Should -Not -Throw
-            $contexts = Get-GitHubContext -ListAvailable -Verbose:$false
+            $contexts = Get-GitHubContextInfo -Verbose:$false
             Write-Verbose ($contexts | Out-String) -Verbose
             ($contexts).Count | Should -Be 3
         }
@@ -72,16 +72,16 @@ Describe 'GitHub' {
                 PrivateKey = $env:TEST_APP_PRIVATE_KEY
             }
             { Connect-GitHubAccount @params -AutoloadInstallations } | Should -Not -Throw
-            $contexts = Get-GitHubContext -ListAvailable -Verbose:$false
+            $contexts = Get-GitHubContextInfo -Verbose:$false
             Write-Verbose ($contexts | Out-String) -Verbose
             ($contexts).Count | Should -Be 7
         }
 
         It 'Can disconnect a specific context' {
             { Disconnect-GitHubAccount -Context 'github.com/psmodule-test-app/Organization/PSModule' -Silent } | Should -Not -Throw
-            $contexts = Get-GitHubContext -ListAvailable -Verbose:$false
+            $contexts = Get-GitHubContextInfo -Name 'github.com/psmodule-test-app/*' -Verbose:$false
             Write-Verbose ($contexts | Out-String) -Verbose
-            ($contexts).Count | Should -Be 6
+            ($contexts).Count | Should -Be 3
             Connect-GitHubAccount -ClientID $env:TEST_APP_CLIENT_ID -PrivateKey $env:TEST_APP_PRIVATE_KEY -AutoloadInstallations
             $contexts = Get-GitHubContext -ListAvailable -Verbose:$false
             Write-Verbose ($contexts | Out-String) -Verbose