Fix GitHub Actions step summary generation issues #3061
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -42,17 +42,61 @@ jobs: | |||||||||||||
| - name: Summary - Repository checkout | ||||||||||||||
| shell: pwsh | ||||||||||||||
| run: | | ||||||||||||||
| # Get Cmder version | ||||||||||||||
| . scripts/utils.ps1 | ||||||||||||||
| $cmderVersion = Get-VersionStr | ||||||||||||||
| $buildTime = (Get-Date).ToUniversalTime().ToString("yyyy-MM-ddTHH:mm:ssZ") | ||||||||||||||
|
|
||||||||||||||
| # Determine branch link (handle PR merge refs) | ||||||||||||||
| $branchName = "${{ github.ref_name }}" | ||||||||||||||
| $branchLink = "" | ||||||||||||||
| if ($branchName -match '^(\d+)/(merge|head)$') { | ||||||||||||||
| # This is a PR merge/head ref, link to the PR | ||||||||||||||
| $prNumber = $Matches[1] | ||||||||||||||
| $branchLink = "https://github.com/${{ github.repository }}/pull/$prNumber" | ||||||||||||||
| } elseif ("${{ github.event_name }}" -eq "pull_request") { | ||||||||||||||
| # This is a pull request event, link to the PR | ||||||||||||||
| $branchLink = "https://github.com/${{ github.repository }}/pull/${{ github.event.pull_request.number }}" | ||||||||||||||
| } else { | ||||||||||||||
| # Regular branch, link to the branch tree | ||||||||||||||
| $branchLink = "https://github.com/${{ github.repository }}/tree/${{ github.ref_name }}" | ||||||||||||||
| } | ||||||||||||||
|
|
||||||||||||||
| $summary = @" | ||||||||||||||
| ## 📦 Build Cmder - Workflow Summary | ||||||||||||||
|
|
||||||||||||||
| <small>Build started: $buildTime</small> | ||||||||||||||
|
There was a problem hiding this comment. Using the
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| ### Repository Information | ||||||||||||||
| | Property | Value | | ||||||||||||||
| | --- | --- | | ||||||||||||||
| | Repository | [``${{ github.repository }}``](https://github.com/${{ github.repository }}) | | ||||||||||||||
| | Branch | [``$branchName``]($branchLink) | | ||||||||||||||
| | Commit | [``${{ github.sha }}``](https://github.com/${{ github.repository }}/commit/${{ github.sha }}) | | ||||||||||||||
| | Actor | [@${{ github.actor }}](https://github.com/${{ github.actor }}) | | ||||||||||||||
| | Workflow | ``${{ github.workflow }}`` | | ||||||||||||||
| | Cmder Version | **$cmderVersion** | | ||||||||||||||
|
|
||||||||||||||
| --- | ||||||||||||||
|
|
||||||||||||||
| ### 📁 Vendor Packages | ||||||||||||||
| | Package | Version | | ||||||||||||||
| | --- | --- | | ||||||||||||||
| "@ | ||||||||||||||
|
|
||||||||||||||
| # Read vendor sources.json and add to summary | ||||||||||||||
| $vendorSources = Get-Content "vendor/sources.json" | ConvertFrom-Json | ||||||||||||||
| if ($vendorSources.Count -eq 0) { | ||||||||||||||
| $summary += "`n| _No vendor packages found_ | |" | ||||||||||||||
| } else { | ||||||||||||||
| foreach ($vendor in $vendorSources) { | ||||||||||||||
| $summary += "`n| ``$($vendor.name)`` | $($vendor.version) |" | ||||||||||||||
| } | ||||||||||||||
| } | ||||||||||||||
|
|
||||||||||||||
| $summary += "`n" | ||||||||||||||
|
|
||||||||||||||
| $summary | Add-Content -Path $env:GITHUB_STEP_SUMMARY -Encoding utf8 | ||||||||||||||
|
|
||||||||||||||
| - name: Add MSBuild to PATH | ||||||||||||||
| uses: microsoft/setup-msbuild@v2 | ||||||||||||||
|
|
@@ -66,36 +110,23 @@ jobs: | |||||||||||||
| if: success() | ||||||||||||||
| shell: pwsh | ||||||||||||||
| run: | | ||||||||||||||
| $summary = @" | ||||||||||||||
|
|
||||||||||||||
| --- | ||||||||||||||
|
|
||||||||||||||
| ### Build Status | ||||||||||||||
DRSDavidSoft marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||||||
|
|
||||||||||||||
| ✅ Cmder built successfully. | ||||||||||||||
|
|
||||||||||||||
| "@ | ||||||||||||||
|
|
||||||||||||||
| $summary | Add-Content -Path $env:GITHUB_STEP_SUMMARY -Encoding utf8 | ||||||||||||||
|
|
||||||||||||||
| - name: Pack the built files | ||||||||||||||
| shell: pwsh | ||||||||||||||
| working-directory: scripts | ||||||||||||||
| run: .\pack.ps1 -verbose | ||||||||||||||
|
|
||||||||||||||
| - name: Upload artifact (cmder.zip) | ||||||||||||||
| uses: actions/upload-artifact@v6 | ||||||||||||||
| with: | ||||||||||||||
|
|
@@ -124,15 +155,82 @@ jobs: | |||||||||||||
| - name: Summary - Artifacts uploaded | ||||||||||||||
| if: success() | ||||||||||||||
| shell: pwsh | ||||||||||||||
| env: | ||||||||||||||
| GH_TOKEN: ${{ github.token }} | ||||||||||||||
| run: | | ||||||||||||||
| $summary = @" | ||||||||||||||
|
|
||||||||||||||
| --- | ||||||||||||||
|
|
||||||||||||||
| ### 🗃️ Artifacts | ||||||||||||||
|
|
||||||||||||||
| | Artifact | Size | Download | Hash (SHA256) | | ||||||||||||||
| | --- | --- | --- | --- | | ||||||||||||||
| "@ | ||||||||||||||
|
|
||||||||||||||
| # Function to get artifact download URL with retry logic | ||||||||||||||
| function Get-ArtifactDownloadUrl { | ||||||||||||||
| param( | ||||||||||||||
| [string]$ArtifactName, | ||||||||||||||
| [int]$MaxRetries = 3, | ||||||||||||||
| [int]$DelaySeconds = 2 | ||||||||||||||
| ) | ||||||||||||||
|
|
||||||||||||||
| for ($i = 0; $i -lt $MaxRetries; $i++) { | ||||||||||||||
| try { | ||||||||||||||
| # Use GitHub CLI to get artifact information | ||||||||||||||
| $artifactsJson = gh api "repos/${{ github.repository }}/actions/runs/${{ github.run_id }}/artifacts" --jq ".artifacts[] | select(.name == `"$ArtifactName`")" | ||||||||||||||
|
|
||||||||||||||
| if ($artifactsJson) { | ||||||||||||||
| $artifact = $artifactsJson | ConvertFrom-Json | ||||||||||||||
| if ($artifact.archive_download_url) { | ||||||||||||||
| return $artifact.archive_download_url | ||||||||||||||
| } | ||||||||||||||
| } | ||||||||||||||
| } catch { | ||||||||||||||
| Write-Host "Attempt $($i + 1) failed to get artifact URL for $ArtifactName : $_" | ||||||||||||||
| } | ||||||||||||||
|
|
||||||||||||||
| if ($i -lt ($MaxRetries - 1)) { | ||||||||||||||
| Start-Sleep -Seconds $DelaySeconds | ||||||||||||||
| } | ||||||||||||||
| } | ||||||||||||||
|
|
||||||||||||||
| return $null | ||||||||||||||
| } | ||||||||||||||
|
|
||||||||||||||
| $artifacts = @("cmder.zip", "cmder.7z", "cmder_mini.zip", "hashes.txt") | ||||||||||||||
| foreach ($artifact in $artifacts) { | ||||||||||||||
| $path = "build/$artifact" | ||||||||||||||
| if (Test-Path $path) { | ||||||||||||||
| $size = (Get-Item $path).Length / 1MB | ||||||||||||||
| $hash = (Get-FileHash $path -Algorithm SHA256).Hash | ||||||||||||||
|
There was a problem hiding this comment. The file hash calculation doesn't include error handling. If a file doesn't exist (the Test-Path check passed) but becomes unavailable before Get-FileHash is called, this will cause an error. Consider adding error handling around Get-FileHash or combining the Test-Path check with the hash calculation in a try-catch block.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| # Try to get the actual artifact download URL | ||||||||||||||
| $downloadUrl = Get-ArtifactDownloadUrl -ArtifactName $artifact | ||||||||||||||
| $warning = "" | ||||||||||||||
|
|
||||||||||||||
| if (-not $downloadUrl) { | ||||||||||||||
| # Fallback to workflow run page if artifact URL fetch fails | ||||||||||||||
| $downloadUrl = "https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}" | ||||||||||||||
| $warning = " ⚠️" | ||||||||||||||
| } | ||||||||||||||
|
|
||||||||||||||
| # Determine emoji based on file type | ||||||||||||||
| if ($artifact -match '\.txt$') { | ||||||||||||||
| $emoji = "📄" | ||||||||||||||
| } elseif ($artifact -match '\.(zip|7z)$') { | ||||||||||||||
| $emoji = "🗄️" | ||||||||||||||
| } else { | ||||||||||||||
| $emoji = "📦" | ||||||||||||||
| } | ||||||||||||||
|
|
||||||||||||||
| $summary += "`n| $emoji ``$artifact`` | $([math]::Round($size, 2)) MB | [📥 Download$warning]($downloadUrl) | ``$hash`` |" | ||||||||||||||
| } | ||||||||||||||
| } | ||||||||||||||
| $summary += "`n" | ||||||||||||||
|
|
||||||||||||||
| $summary | Add-Content -Path $env:GITHUB_STEP_SUMMARY -Encoding utf8 | ||||||||||||||
|
|
||||||||||||||
| - name: Create Release | ||||||||||||||
| uses: softprops/action-gh-release@v2 | ||||||||||||||
|
|
@@ -150,14 +248,20 @@ jobs: | |||||||||||||
| if: startsWith(github.ref, 'refs/tags/') | ||||||||||||||
| shell: pwsh | ||||||||||||||
| run: | | ||||||||||||||
| $summary = @" | ||||||||||||||
|
|
||||||||||||||
| --- | ||||||||||||||
|
|
||||||||||||||
| ### Release Information | ||||||||||||||
|
|
||||||||||||||
| 🚀 Draft release created for tag: **``${{ github.ref_name }}``** | ||||||||||||||
|
Comment on lines
+255
to
+257
There was a problem hiding this comment. The heading "Release Information" is missing an emoji prefix, while the content below uses the 🚀 emoji. For consistency with other section headings, consider moving the emoji to the heading itself (e.g., "### 🚀 Release Information") rather than having it in the body text.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| Release includes: | ||||||||||||||
| - Full version (``cmder.zip``, ``cmder.7z``) | ||||||||||||||
| - Mini version (``cmder_mini.zip``) | ||||||||||||||
| - File hashes (``hashes.txt``) | ||||||||||||||
|
|
||||||||||||||
| > ⚠️ Release is in **draft** mode. Please review and publish manually. | ||||||||||||||
| "@ | ||||||||||||||
|
|
||||||||||||||
| $summary | Add-Content -Path $env:GITHUB_STEP_SUMMARY -Encoding utf8 | ||||||||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The script sources utils.ps1 without error handling. If the script file doesn't exist or has syntax errors, this will cause the step to fail. Consider adding error handling to verify the script exists and can be loaded successfully.