🩹 [Patch]: Update all classes formats to hyperlink to resources (#438)

MariusStorhaug · web-flow · commit 248b2a1411cd · 2025-06-27T22:42:25.000+02:00
## Description This pull request introduces several enhancements and fixes across the codebase, focusing on improving functionality, readability, and modularity. Key changes include updates to the `GitHubArtifact` class, refinements in configuration handling, improved hyperlink formatting, and adjustments to environment detection logic. ### Enhancements to `GitHubArtifact` Class: * Added a new `HostName` parameter to the `GitHubArtifact` constructor to dynamically construct artifact URLs based on the host. Updated all relevant artifact retrieval functions (`Get-GitHubArtifactById`, `Get-GitHubArtifactFromRepository`, and `Get-GitHubArtifactFromWorkflowRun`) to pass the `HostName` parameter. ### Configuration Improvements: * Introduced a new `EnvironmentType` property in the `GitHubConfig` class to better define the context for GitHub API calls. * Added a new XML format definition (`GitHubConfig.Format.ps1xml`) for displaying `GitHubConfig` objects in a list view, including properties such as `HostName`, `ApiBaseUri`, and `EnvironmentType`. * Refactored the `Get-GitHubConfig` function to support two parameter sets for retrieving either the entire module configuration or a specific configuration item. ### Hyperlink Formatting: * Updated hyperlink formatting across multiple XML format files (`GitHubArtifact.Format.ps1xml`, `GitHubEnvironment.Format.ps1xml`, `GitHubLicense.Format.ps1xml`, `GitHubOwner.Format.ps1xml`, `GitHubRelease.Format.ps1xml`, `GitHubRepository.Format.ps1xml`, `GitHubTeam.Format.ps1xml`) to use `PSStyle.FormatHyperlink` for better compatibility with virtual terminal support. Fallback ensures plain text formatting when virtual terminal is not supported or in GitHub Actions environments. ### Environment Detection Logic: * Replaced direct checks for `GITHUB_ACTIONS` and `WEBSITE_PLATFORM_VERSION` environment variables with new script-level flags (`IsGitHubActions` and `IsFunctionApp`) for determining runtime environments. Updated references across multiple functions (`Set-GitHubContext`, `Get-GitHubEnvironmentType`, `Connect-GitHubAccount`, `Connect-GitHubApp`, `Disconnect-GitHubAccount`). ### Minor Changes: * Added support for additional type names (`GitHubUser` and `GitHubOrganization`) in the `GitHubOwnerTable` view definition. ## Type of change  - [ ] 📖 [Docs] - [ ] 🪲 [Fix] - [x] 🩹 [Patch] - [ ] ⚠️ [Security fix] - [ ] 🚀 [Feature] - [ ] 🌟 [Breaking change] ## Checklist  - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas
diff --git a/src/classes/public/Artifacts/GitHubArtifact.ps1 b/src/classes/public/Artifacts/GitHubArtifact.ps1
@@ -37,14 +37,14 @@
 
     GitHubArtifact() {}
 
-    GitHubArtifact([PSCustomObject]$Object, [string]$Owner, [string]$Repository) {
+    GitHubArtifact([PSCustomObject]$Object, [string]$Owner, [string]$Repository, [string]$HostName) {
         $this.ID = $Object.id
         $this.NodeID = $Object.node_id
         $this.Name = $Object.name
         $this.Owner = $Owner
         $this.Repository = $Repository
         $this.Size = $Object.size_in_bytes
-        $this.Url = $Object.url
+        $this.Url = "https://$($HostName)/$Owner/$Repository/actions/runs/$($Object.workflow_run.id)/artifacts/$($Object.id)"
         $this.ArchiveDownloadUrl = $Object.archive_download_url
         $this.Expired = $Object.expired
         $this.Digest = $Object.digest
diff --git a/src/classes/public/Config/GitHubConfig.ps1 b/src/classes/public/Config/GitHubConfig.ps1
@@ -38,6 +38,9 @@
     # The tolerance time in seconds for JWT token validation.
     [System.Nullable[int]] $JwtTimeTolerance
 
+    # The environment type, which is used to determine the context of the GitHub API calls.
+    [string] $EnvironmentType
+
     # Simple parameterless constructor
     GitHubConfig() {}
 
diff --git a/src/formats/GitHubArtifact.Format.ps1xml b/src/formats/GitHubArtifact.Format.ps1xml
@@ -34,7 +34,14 @@
                                 <PropertyName>ID</PropertyName>
                             </TableColumnItem>
                             <TableColumnItem>
-                                <ScriptBlock>"`e]8;;$($_.Url)`e\$($_.Name)`e]8;;`e\"</ScriptBlock>
+                                <ScriptBlock>
+                                    if ($Host.UI.SupportsVirtualTerminal -and
+                                    ($env:GITHUB_ACTIONS -ne 'true')) {
+                                    $PSStyle.FormatHyperlink($_.Name,$_.Url)
+                                    } else {
+                                    $_.Name
+                                    }
+                                </ScriptBlock>
                             </TableColumnItem>
                             <TableColumnItem>
                                 <ScriptBlock>'{0:F2}' -f ([math]::Round($_.Size / 1KB, 2))</ScriptBlock>
diff --git a/src/formats/GitHubConfig.Format.ps1xml b/src/formats/GitHubConfig.Format.ps1xml
@@ -0,0 +1,58 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Configuration>
+    <ViewDefinitions>
+        <View>
+            <Name>GitHubConfigListView</Name>
+            <ViewSelectedBy>
+                <TypeName>GitHubConfig</TypeName>
+            </ViewSelectedBy>
+            <ListControl>
+                <ListEntries>
+                    <ListEntry>
+                        <ListItems>
+                            <ListItem>
+                                <PropertyName>HostName</PropertyName>
+                            </ListItem>
+                            <ListItem>
+                                <PropertyName>ApiBaseUri</PropertyName>
+                            </ListItem>
+                            <ListItem>
+                                <PropertyName>GitHubAppClientID</PropertyName>
+                            </ListItem>
+                            <ListItem>
+                                <PropertyName>OAuthAppClientID</PropertyName>
+                            </ListItem>
+                            <ListItem>
+                                <PropertyName>EnvironmentType</PropertyName>
+                            </ListItem>
+                            <ListItem>
+                                <PropertyName>DefaultContext</PropertyName>
+                            </ListItem>
+                            <ListItem>
+                                <PropertyName>AccessTokenGracePeriodInHours</PropertyName>
+                            </ListItem>
+                            <ListItem>
+                                <PropertyName>JwtTimeTolerance</PropertyName>
+                            </ListItem>
+                            <ListItem>
+                                <PropertyName>ApiVersion</PropertyName>
+                            </ListItem>
+                            <ListItem>
+                                <PropertyName>HttpVersion</PropertyName>
+                            </ListItem>
+                            <ListItem>
+                                <PropertyName>PerPage</PropertyName>
+                            </ListItem>
+                            <ListItem>
+                                <PropertyName>RetryCount</PropertyName>
+                            </ListItem>
+                            <ListItem>
+                                <PropertyName>RetryInterval</PropertyName>
+                            </ListItem>
+                        </ListItems>
+                    </ListEntry>
+                </ListEntries>
+            </ListControl>
+        </View>
+    </ViewDefinitions>
+</Configuration>
diff --git a/src/formats/GitHubEnvironment.Format.ps1xml b/src/formats/GitHubEnvironment.Format.ps1xml
@@ -22,7 +22,14 @@
                     <TableRowEntry>
                         <TableColumnItems>
                             <TableColumnItem>
-                                <ScriptBlock>"`e]8;;$($_.Url)`e\$($_.Name)`e]8;;`e\"</ScriptBlock>
+                                <ScriptBlock>
+                                    if ($Host.UI.SupportsVirtualTerminal -and
+                                    ($env:GITHUB_ACTIONS -ne 'true')) {
+                                    $PSStyle.FormatHyperlink($_.Name,$_.Url)
+                                    } else {
+                                    $_.Name
+                                    }
+                                </ScriptBlock>
                             </TableColumnItem>
                             <TableColumnItem>
                                 <PropertyName>Repository</PropertyName>
diff --git a/src/formats/GitHubLicense.Format.ps1xml b/src/formats/GitHubLicense.Format.ps1xml
@@ -31,7 +31,14 @@
                                 <PropertyName>Key</PropertyName>
                             </TableColumnItem>
                             <TableColumnItem>
-                                <ScriptBlock>"`e]8;;$($_.Url)`e\$($_.Name)`e]8;;`e\"</ScriptBlock>
+                                <ScriptBlock>
+                                    if ($Host.UI.SupportsVirtualTerminal -and
+                                    ($env:GITHUB_ACTIONS -ne 'true')) {
+                                    $PSStyle.FormatHyperlink($_.Name,$_.Url)
+                                    } else {
+                                    $_.Name
+                                    }
+                                </ScriptBlock>
                             </TableColumnItem>
                             <TableColumnItem>
                                 <PropertyName>SpdxId</PropertyName>
diff --git a/src/formats/GitHubOwner.Format.ps1xml b/src/formats/GitHubOwner.Format.ps1xml
@@ -5,6 +5,8 @@
             <Name>GitHubOwnerTable</Name>
             <ViewSelectedBy>
                 <TypeName>GitHubOwner</TypeName>
+                <TypeName>GitHubUser</TypeName>
+                <TypeName>GitHubOrganization</TypeName>
             </ViewSelectedBy>
             <TableControl>
                 <TableHeaders>
@@ -28,7 +30,14 @@
                     <TableRowEntry>
                         <TableColumnItems>
                             <TableColumnItem>
-                                <ScriptBlock>"`e]8;;$($_.Url)`e\$($_.Name)`e]8;;`e\"</ScriptBlock>
+                                <ScriptBlock>
+                                    if ($Host.UI.SupportsVirtualTerminal -and
+                                    ($env:GITHUB_ACTIONS -ne 'true')) {
+                                    $PSStyle.FormatHyperlink($_.Name,$_.Url)
+                                    } else {
+                                    $_.Name
+                                    }
+                                </ScriptBlock>
                             </TableColumnItem>
                             <TableColumnItem>
                                 <PropertyName>ID</PropertyName>
diff --git a/src/formats/GitHubRelease.Format.ps1xml b/src/formats/GitHubRelease.Format.ps1xml
@@ -31,7 +31,14 @@
                     <TableRowEntry>
                         <TableColumnItems>
                             <TableColumnItem>
-                                <ScriptBlock>"`e]8;;$($_.Url)`e\$($_.Tag)`e]8;;`e\"</ScriptBlock>
+                                <ScriptBlock>
+                                    if ($Host.UI.SupportsVirtualTerminal -and
+                                    ($env:GITHUB_ACTIONS -ne 'true')) {
+                                    $PSStyle.FormatHyperlink($_.Tag,$_.Url)
+                                    } else {
+                                    $_.Tag
+                                    }
+                                </ScriptBlock>
                             </TableColumnItem>
                             <TableColumnItem>
                                 <PropertyName>Owner</PropertyName>
diff --git a/src/formats/GitHubRepository.Format.ps1xml b/src/formats/GitHubRepository.Format.ps1xml
@@ -25,7 +25,14 @@
                     <TableRowEntry>
                         <TableColumnItems>
                             <TableColumnItem>
-                                <ScriptBlock>"`e]8;;$($_.Url)`e\$($_.Name)`e]8;;`e\"</ScriptBlock>
+                                <ScriptBlock>
+                                    if ($Host.UI.SupportsVirtualTerminal -and
+                                    ($env:GITHUB_ACTIONS -ne 'true')) {
+                                    $PSStyle.FormatHyperlink($_.Name,$_.Url)
+                                    } else {
+                                    $_.Name
+                                    }
+                                </ScriptBlock>
                             </TableColumnItem>
                             <TableColumnItem>
                                 <PropertyName>Owner</PropertyName>
diff --git a/src/formats/GitHubTeam.Format.ps1xml b/src/formats/GitHubTeam.Format.ps1xml
@@ -19,7 +19,14 @@
                     <TableRowEntry>
                         <TableColumnItems>
                             <TableColumnItem>
-                                <ScriptBlock>"`e]8;;$($_.Url)`e\$($_.Name)`e]8;;`e\"</ScriptBlock>
+                                <ScriptBlock>
+                                    if ($Host.UI.SupportsVirtualTerminal -and
+                                    ($env:GITHUB_ACTIONS -ne 'true')) {
+                                    $PSStyle.FormatHyperlink($_.Name,$_.Url)
+                                    } else {
+                                    $_.Name
+                                    }
+                                </ScriptBlock>
                             </TableColumnItem>
                             <TableColumnItem>
                                 <PropertyName>Owner</PropertyName>
diff --git a/src/functions/private/Artifacts/Get-GitHubArtifactById.ps1 b/src/functions/private/Artifacts/Get-GitHubArtifactById.ps1
@@ -68,7 +68,7 @@ function Get-GitHubArtifactById {
         }
 
         Invoke-GitHubAPI @inputObject | ForEach-Object {
-            [GitHubArtifact]::new($_.Response, $Owner, $Repository)
+            [GitHubArtifact]::new($_.Response, $Owner, $Repository, $Context.HostName)
         }
     }
 
diff --git a/src/functions/private/Artifacts/Get-GitHubArtifactFromRepository.ps1 b/src/functions/private/Artifacts/Get-GitHubArtifactFromRepository.ps1
@@ -88,7 +88,7 @@ function Get-GitHubArtifactFromRepository {
         }
 
         $artifacts | ForEach-Object {
-            [GitHubArtifact]::new($_, $Owner, $Repository)
+            [GitHubArtifact]::new($_, $Owner, $Repository, $Context.HostName)
         }
     }
 
diff --git a/src/functions/private/Artifacts/Get-GitHubArtifactFromWorkflowRun.ps1 b/src/functions/private/Artifacts/Get-GitHubArtifactFromWorkflowRun.ps1
@@ -99,7 +99,7 @@ function Get-GitHubArtifactFromWorkflowRun {
         }
 
         $artifacts | ForEach-Object {
-            [GitHubArtifact]::new($_, $Owner, $Repository)
+            [GitHubArtifact]::new($_, $Owner, $Repository, $Context.HostName)
         }
     }
 
diff --git a/src/functions/private/Auth/Context/Set-GitHubContext.ps1 b/src/functions/private/Auth/Context/Set-GitHubContext.ps1
@@ -83,7 +83,7 @@
                             Write-Debug "Failed to get the GitHub App with the slug: [$($contextObj['Username'])]."
                         }
                     }
-                    if ($script:GitHub.EnvironmentType -eq 'GHA') {
+                    if ($script:IsGitHubActions) {
                         $gitHubEvent = Get-Content -Path $env:GITHUB_EVENT_PATH -Raw | ConvertFrom-Json
                         $installationType = $gitHubEvent.repository.owner.type
                         $installationName = $gitHubEvent.repository.owner.login
@@ -146,7 +146,7 @@
                 if ($Default) {
                     Switch-GitHubContext -Context $contextObj['Name']
                 }
-                if ($script:GitHub.EnvironmentType -eq 'GHA') {
+                if ($script:IsGitHubActions) {
                     if ($contextObj['AuthType'] -ne 'APP') {
                         Set-GitHubGitConfig -Context $contextObj['Name']
                         Connect-GitHubCli -Context $contextObj
diff --git a/src/functions/private/Auth/Context/completers.ps1 b/src/functions/private/Auth/Context/completers.ps1
diff --git a/src/functions/private/Config/Get-GitHubEnvironmentType.ps1 b/src/functions/private/Config/Get-GitHubEnvironmentType.ps1
@@ -19,10 +19,10 @@
     }
 
     process {
-        if ($env:GITHUB_ACTIONS -eq 'true') {
+        if ($script:IsGitHubActions) {
             Write-Debug 'Detected GitHub Actions environment.'
             return 'GHA'
-        } elseif (-not [string]::IsNullOrEmpty($env:WEBSITE_PLATFORM_VERSION)) {
+        } elseif ($script:IsFunctionApp) {
             Write-Debug 'Detected Azure Functions environment.'
             return 'AFA'
         } else {
diff --git a/src/functions/public/Auth/Connect-GitHubAccount.ps1 b/src/functions/public/Auth/Connect-GitHubAccount.ps1
@@ -296,7 +296,7 @@
             $contextObj | Format-List | Out-String -Stream | ForEach-Object { Write-Verbose $_ }
             if (-not $Silent) {
                 $name = $contextObj.Username
-                if ($script:GitHub.EnvironmentType -eq 'GHA') {
+                if ($script:IsGitHubActions) {
                     $green = $PSStyle.Foreground.Green
                     $reset = $PSStyle.Reset
                     Write-Host "$green✓$reset Logged in as $name!"
diff --git a/src/functions/public/Auth/Connect-GitHubApp.ps1 b/src/functions/public/Auth/Connect-GitHubApp.ps1
@@ -163,7 +163,7 @@
             $contextObj | Format-List | Out-String -Stream | ForEach-Object { Write-Verbose $_ }
             if (-not $Silent) {
                 $name = $contextObj.Name
-                if ($script:GitHub.EnvironmentType -eq 'GHA') {
+                if ($script:IsGitHubActions) {
                     $green = $PSStyle.Foreground.Green
                     $reset = $PSStyle.Reset
                     Write-Host "$green✓$reset Connected $name!"
diff --git a/src/functions/public/Auth/Disconnect-GitHubAccount.ps1 b/src/functions/public/Auth/Disconnect-GitHubAccount.ps1
@@ -57,7 +57,7 @@
             }
 
             if (-not $Silent) {
-                if ($script:GitHub.EnvironmentType -eq 'GHA') {
+                if ($script:IsGitHubActions) {
                     $green = $PSStyle.Foreground.Green
                     $reset = $PSStyle.Reset
                     Write-Host "$green✓$reset Logged out of GitHub! [$contextItem]"
diff --git a/src/functions/public/Config/Get-GitHubConfig.ps1 b/src/functions/public/Config/Get-GitHubConfig.ps1
@@ -11,14 +11,17 @@
 
         Get the DefaultContext value from the GitHub module configuration.
 
+
+
         .LINK
         https://psmodule.io/GitHub/Functions/Config/Get-GitHubConfig
     #>
-    [OutputType([object], [GitHubConfig])]
-    [CmdletBinding()]
+    [OutputType([GitHubConfig], ParameterSetName = 'Get the module configuration')]
+    [OutputType([object], ParameterSetName = 'Get a specific configuration item')]
+    [CmdletBinding(DefaultParameterSetName = 'Get the module configuration')]
     param(
         # The name of the configuration to get.
-        [Parameter()]
+        [Parameter(Mandatory, ParameterSetName = 'Get a specific configuration item')]
         [string] $Name
     )
 
@@ -29,11 +32,15 @@
     }
 
     process {
-        if (-not $Name) {
-            Get-Context -ID $script:GitHub.Config.ID -Vault $script:GitHub.ContextVault | Select-Object -ExcludeProperty ID
+        switch ($PSCmdlet.ParameterSetName) {
+            'Get the module configuration' {
+                $item = Get-Context -ID $script:GitHub.Config.ID -Vault $script:GitHub.ContextVault | Select-Object -ExcludeProperty ID
+                [GitHubConfig]::new($item)
+            }
+            'Get a specific configuration item' {
+                $script:GitHub.Config.$Name
+            }
         }
-
-        $script:GitHub.Config.$Name
     }
 
     end {
diff --git a/src/functions/public/Config/Set-GitHubConfig.ps1 b/src/functions/public/Config/Set-GitHubConfig.ps1
@@ -11,9 +11,13 @@
 
         Sets the value of DefaultUser to 'Octocat' in the GitHub module configuration.
 
+        .OUTPUTS
+        GitHubConfig
+
         .LINK
         https://psmodule.io/GitHub/Functions/Config/Set-GitHubConfig
     #>
+    [OutputType([GitHubConfig])]
     [CmdletBinding(SupportsShouldProcess)]
     param(
         # Set the access token type.
@@ -39,7 +43,10 @@
         Write-Verbose "Setting [$Name] to [$Value]"
         $script:GitHub.Config.$Name = $Value
         if ($PSCmdlet.ShouldProcess('ContextSetting', 'Set')) {
-            Set-Context -Context $script:GitHub.Config -Vault $script:GitHub.ContextVault -PassThru:$PassThru
+            $item = Set-Context -Context $script:GitHub.Config -Vault $script:GitHub.ContextVault -PassThru:$PassThru
+            if ($PassThru) {
+                [GitHubConfig]::new($item)
+            }
         }
     }
 
diff --git a/src/loader.ps1 b/src/loader.ps1
@@ -6,14 +6,12 @@ if ($Host.UI.SupportsVirtualTerminal) {
     $PSStyle.OutputRendering = 'Ansi'
 }
 
-switch ($script:GitHub.EnvironmentType) {
-    'GHA' {
-        Write-Verbose 'Detected running on a GitHub Actions runner, preparing environment...'
-        $env:GITHUB_REPOSITORY_NAME = $env:GITHUB_REPOSITORY -replace '.+/'
-        Set-GitHubEnvironmentVariable -Name 'GITHUB_REPOSITORY_NAME' -Value $env:GITHUB_REPOSITORY_NAME
-        $env:GITHUB_HOST_NAME = ($env:GITHUB_SERVER_URL ?? 'github.com') -replace '^https?://'
-        Set-GitHubEnvironmentVariable -Name 'GITHUB_HOST_NAME' -Value $env:GITHUB_HOST_NAME
-        Import-GitHubEventData
-        Import-GitHubRunnerData
-    }
+if ($script:IsGitHubActions) {
+    Write-Verbose 'Detected running on a GitHub Actions runner, preparing environment...'
+    $env:GITHUB_REPOSITORY_NAME = $env:GITHUB_REPOSITORY -replace '.+/'
+    Set-GitHubEnvironmentVariable -Name 'GITHUB_REPOSITORY_NAME' -Value $env:GITHUB_REPOSITORY_NAME
+    $env:GITHUB_HOST_NAME = ($env:GITHUB_SERVER_URL ?? 'github.com') -replace '^https?://'
+    Set-GitHubEnvironmentVariable -Name 'GITHUB_HOST_NAME' -Value $env:GITHUB_HOST_NAME
+    Import-GitHubEventData
+    Import-GitHubRunnerData
 }
diff --git a/src/variables/private/GitHub.ps1 b/src/variables/private/GitHub.ps1
@@ -1,4 +1,7 @@
-﻿$script:GitHub = [pscustomobject]@{
+﻿$script:IsGitHubActions = $env:GITHUB_ACTIONS -eq 'true'
+$script:IsFunctionApp = -not [string]::IsNullOrEmpty($env:WEBSITE_PLATFORM_VERSION)
+$script:IsLocal = -not ($script:IsGitHubActions -or $script:IsFunctionApp)
+$script:GitHub = [pscustomobject]@{
     ContextVault       = 'PSModule.GitHub'
     TokenPrefixPattern = '(?<=^(ghu|gho|ghs|github_pat|ghp)).*'
     EnvironmentType    = Get-GitHubEnvironmentType
@@ -16,6 +19,7 @@
         RetryCount                    = 0
         RetryInterval                 = 1
         JwtTimeTolerance              = 300
+        EnvironmentType               = Get-GitHubEnvironmentType
     }
     Config             = $null
     Event              = $null
