-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Add GITHUB_STEP_SUMMARY to CI/CD workflows #3058
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
d285f63
Initial plan
Copilot 0db2dbf
Add GITHUB_STEP_SUMMARY to all CI/CD workflows
Copilot 40ddf9a
Add success conditionals to test summary steps
Copilot 25ac8f1
Refactor artifact summary to use loop and improve pluralization
Copilot 6da8e58
Improve pluralization clarity, fix test table headers, and add hash c…
Copilot 799f63d
Add success conditionals to upload summary and separate test completi…
Copilot 148f685
Add missing success conditionals to CodeQL and branches workflows
Copilot 6a69804
Add success conditionals to build and package summary steps
Copilot 1509616
Merge branch 'master' into copilot/add-github-step-summary
DRSDavidSoft File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 | ||||
|---|---|---|---|---|---|---|
|
|
@@ -39,6 +39,21 @@ jobs: | |||||
| with: | ||||||
| fetch-depth: 0 | ||||||
|
|
||||||
| - name: Summary - Repository checkout | ||||||
| shell: pwsh | ||||||
| run: | | ||||||
| echo "## 📦 Build Cmder - Workflow Summary" >> $env:GITHUB_STEP_SUMMARY | ||||||
| echo "" >> $env:GITHUB_STEP_SUMMARY | ||||||
| echo "### Repository Information" >> $env:GITHUB_STEP_SUMMARY | ||||||
| echo "| Property | Value |" >> $env:GITHUB_STEP_SUMMARY | ||||||
| echo "| --- | --- |" >> $env:GITHUB_STEP_SUMMARY | ||||||
| echo "| Repository | \`${{ github.repository }}\` |" >> $env:GITHUB_STEP_SUMMARY | ||||||
| echo "| Branch | \`${{ github.ref_name }}\` |" >> $env:GITHUB_STEP_SUMMARY | ||||||
| echo "| Commit | \`${{ github.sha }}\` |" >> $env:GITHUB_STEP_SUMMARY | ||||||
| echo "| Actor | @${{ github.actor }} |" >> $env:GITHUB_STEP_SUMMARY | ||||||
| echo "| Workflow | \`${{ github.workflow }}\` |" >> $env:GITHUB_STEP_SUMMARY | ||||||
| echo "" >> $env:GITHUB_STEP_SUMMARY | ||||||
|
|
||||||
| - name: Add MSBuild to PATH | ||||||
| uses: microsoft/setup-msbuild@v2 | ||||||
|
|
||||||
|
|
@@ -47,11 +62,40 @@ jobs: | |||||
| working-directory: scripts | ||||||
| run: .\build.ps1 -Compile -verbose | ||||||
|
|
||||||
| - name: Summary - Build completed | ||||||
| if: success() | ||||||
| shell: pwsh | ||||||
| run: | | ||||||
| echo "### ✅ Build Status" >> $env:GITHUB_STEP_SUMMARY | ||||||
| echo "" >> $env:GITHUB_STEP_SUMMARY | ||||||
| echo "Cmder launcher successfully compiled." >> $env:GITHUB_STEP_SUMMARY | ||||||
| echo "" >> $env:GITHUB_STEP_SUMMARY | ||||||
|
|
||||||
| - name: Pack the built files | ||||||
| shell: pwsh | ||||||
| working-directory: scripts | ||||||
| run: .\pack.ps1 -verbose | ||||||
|
|
||||||
| - name: Summary - Package artifacts | ||||||
| if: success() | ||||||
| shell: pwsh | ||||||
| run: | | ||||||
| echo "### 📦 Artifacts Created" >> $env:GITHUB_STEP_SUMMARY | ||||||
| echo "" >> $env:GITHUB_STEP_SUMMARY | ||||||
| echo "| Artifact | Size | Hash (SHA256) |" >> $env:GITHUB_STEP_SUMMARY | ||||||
| echo "| --- | --- | --- |" >> $env:GITHUB_STEP_SUMMARY | ||||||
| $artifacts = @("cmder.zip", "cmder.7z", "cmder_mini.zip") | ||||||
| foreach ($artifact in $artifacts) { | ||||||
| $path = "build/$artifact" | ||||||
| if (Test-Path $path) { | ||||||
| $size = (Get-Item $path).Length / 1MB | ||||||
| # Truncate hash to first 16 chars for summary readability (full hash in hashes.txt) | ||||||
| $hash = (Get-FileHash $path -Algorithm SHA256).Hash.Substring(0, 16) | ||||||
| echo "| \`$artifact\` | $([math]::Round($size, 2)) MB | \`$hash...\` |" >> $env:GITHUB_STEP_SUMMARY | ||||||
|
||||||
| echo "| \`$artifact\` | $([math]::Round($size, 2)) MB | \`$hash...\` |" >> $env:GITHUB_STEP_SUMMARY | |
| echo "| ``$artifact`` | $([math]::Round($size, 2)) MB | ``$hash...`` |" >> $env:GITHUB_STEP_SUMMARY |
Comment on lines
+131
to
+134
Copilot
AI
Dec 8, 2025
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.
Incorrect escape sequence for backticks in PowerShell. The syntax \cmder.zip`will output literal backslashes followed by backticks, not markdown-formatted code. In PowerShell, use doubled backticks to escape backticks: change`cmder.zip`` to ``cmder.zip``, and similarly for lines 132-134.
Copilot
AI
Dec 8, 2025
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.
Incorrect escape sequence for backticks in PowerShell. The syntax \${{ github.ref_name }}`will output literal backslashes followed by backticks, not markdown-formatted code. In PowerShell, use doubled backticks to escape backticks: change`${{ github.ref_name }}`` to ``${{ github.ref_name }}``.
Suggested change
| echo "Draft release created for tag: **\`${{ github.ref_name }}\`**" >> $env:GITHUB_STEP_SUMMARY | |
| echo "Draft release created for tag: **``${{ github.ref_name }}``**" >> $env:GITHUB_STEP_SUMMARY |
Comment on lines
+158
to
+160
Copilot
AI
Dec 8, 2025
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.
Incorrect escape sequence for backticks in PowerShell. The syntax \cmder.zip`and similar will output literal backslashes followed by backticks, not markdown-formatted code. In PowerShell, use doubled backticks to escape backticks: change`cmder.zip`to ``` ``cmder.zip`` ```, and similarly forcmder.7z, cmder_mini.zip, and hashes.txt` on lines 158-160.
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 | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -47,6 +47,21 @@ jobs: | |||||||||||||||||
| - name: Checkout repository | ||||||||||||||||||
| uses: actions/checkout@v6 | ||||||||||||||||||
|
|
||||||||||||||||||
| - name: Summary - CodeQL analysis started | ||||||||||||||||||
| shell: pwsh | ||||||||||||||||||
| run: | | ||||||||||||||||||
| echo "## 🔒 CodeQL Security Analysis - Workflow Summary" >> $env:GITHUB_STEP_SUMMARY | ||||||||||||||||||
| echo "" >> $env:GITHUB_STEP_SUMMARY | ||||||||||||||||||
| echo "### Analysis Configuration" >> $env:GITHUB_STEP_SUMMARY | ||||||||||||||||||
| echo "" >> $env:GITHUB_STEP_SUMMARY | ||||||||||||||||||
| echo "| Property | Value |" >> $env:GITHUB_STEP_SUMMARY | ||||||||||||||||||
| echo "| --- | --- |" >> $env:GITHUB_STEP_SUMMARY | ||||||||||||||||||
| echo "| Repository | \`${{ github.repository }}\` |" >> $env:GITHUB_STEP_SUMMARY | ||||||||||||||||||
| echo "| Branch | \`${{ github.ref_name }}\` |" >> $env:GITHUB_STEP_SUMMARY | ||||||||||||||||||
| echo "| Language | \`${{ matrix.language }}\` |" >> $env:GITHUB_STEP_SUMMARY | ||||||||||||||||||
| echo "| Commit | \`${{ github.sha }}\` |" >> $env:GITHUB_STEP_SUMMARY | ||||||||||||||||||
|
Comment on lines
+59
to
+62
|
||||||||||||||||||
| echo "| Repository | \`${{ github.repository }}\` |" >> $env:GITHUB_STEP_SUMMARY | |
| echo "| Branch | \`${{ github.ref_name }}\` |" >> $env:GITHUB_STEP_SUMMARY | |
| echo "| Language | \`${{ matrix.language }}\` |" >> $env:GITHUB_STEP_SUMMARY | |
| echo "| Commit | \`${{ github.sha }}\` |" >> $env:GITHUB_STEP_SUMMARY | |
| echo "| Repository | ``${{ github.repository }}`` |" >> $env:GITHUB_STEP_SUMMARY | |
| echo "| Branch | ``${{ github.ref_name }}`` |" >> $env:GITHUB_STEP_SUMMARY | |
| echo "| Language | ``${{ matrix.language }}`` |" >> $env:GITHUB_STEP_SUMMARY | |
| echo "| Commit | ``${{ github.sha }}`` |" >> $env:GITHUB_STEP_SUMMARY |
Copilot
AI
Dec 8, 2025
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.
Incorrect escape sequence for backticks in PowerShell. The syntax \${{ matrix.language }}`will output literal backslashes followed by backticks, not markdown-formatted code. In PowerShell, use doubled backticks to escape backticks: change`${{ matrix.language }}`` to ``${{ matrix.language }}``.
Suggested change
| echo "**Language analyzed:** \`${{ matrix.language }}\`" >> $env:GITHUB_STEP_SUMMARY | |
| echo "**Language analyzed:** ``${{ matrix.language }}``" >> $env:GITHUB_STEP_SUMMARY |
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 | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -39,16 +39,77 @@ jobs: | |||||||||||||||||
|
|
||||||||||||||||||
| steps: | ||||||||||||||||||
| - uses: actions/checkout@v6 | ||||||||||||||||||
|
|
||||||||||||||||||
| - name: Summary - Test execution started | ||||||||||||||||||
| shell: pwsh | ||||||||||||||||||
| run: | | ||||||||||||||||||
| echo "## 🧪 Run Tests - Workflow Summary" >> $env:GITHUB_STEP_SUMMARY | ||||||||||||||||||
| echo "" >> $env:GITHUB_STEP_SUMMARY | ||||||||||||||||||
| echo "### Test Environment" >> $env:GITHUB_STEP_SUMMARY | ||||||||||||||||||
| echo "| Property | Value |" >> $env:GITHUB_STEP_SUMMARY | ||||||||||||||||||
| echo "| --- | --- |" >> $env:GITHUB_STEP_SUMMARY | ||||||||||||||||||
| echo "| Repository | \`${{ github.repository }}\` |" >> $env:GITHUB_STEP_SUMMARY | ||||||||||||||||||
| echo "| Branch | \`${{ github.ref_name }}\` |" >> $env:GITHUB_STEP_SUMMARY | ||||||||||||||||||
| echo "| Commit | \`${{ github.sha }}\` |" >> $env:GITHUB_STEP_SUMMARY | ||||||||||||||||||
| echo "| Runner OS | \`${{ runner.os }}\` |" >> $env:GITHUB_STEP_SUMMARY | ||||||||||||||||||
|
Comment on lines
+51
to
+54
|
||||||||||||||||||
| echo "| Repository | \`${{ github.repository }}\` |" >> $env:GITHUB_STEP_SUMMARY | |
| echo "| Branch | \`${{ github.ref_name }}\` |" >> $env:GITHUB_STEP_SUMMARY | |
| echo "| Commit | \`${{ github.sha }}\` |" >> $env:GITHUB_STEP_SUMMARY | |
| echo "| Runner OS | \`${{ runner.os }}\` |" >> $env:GITHUB_STEP_SUMMARY | |
| echo "| Repository | ``${{ github.repository }}`` |" >> $env:GITHUB_STEP_SUMMARY | |
| echo "| Branch | ``${{ github.ref_name }}`` |" >> $env:GITHUB_STEP_SUMMARY | |
| echo "| Commit | ``${{ github.sha }}`` |" >> $env:GITHUB_STEP_SUMMARY | |
| echo "| Runner OS | ``${{ runner.os }}`` |" >> $env:GITHUB_STEP_SUMMARY |
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 | ||||
|---|---|---|---|---|---|---|
|
|
@@ -28,6 +28,14 @@ jobs: | |||||
| with: | ||||||
| fetch-depth: 0 | ||||||
|
|
||||||
| - name: Summary - Workflow started | ||||||
| shell: pwsh | ||||||
| run: | | ||||||
| echo "## 📦 Update Vendor - Workflow Summary" >> $env:GITHUB_STEP_SUMMARY | ||||||
| echo "" >> $env:GITHUB_STEP_SUMMARY | ||||||
| echo "Checking for vendor dependency updates..." >> $env:GITHUB_STEP_SUMMARY | ||||||
| echo "" >> $env:GITHUB_STEP_SUMMARY | ||||||
|
|
||||||
| - id: make-changes | ||||||
| name: Checking for updates | ||||||
| env: | ||||||
|
|
@@ -51,6 +59,24 @@ jobs: | |||||
| Set-GHVariable -Name LIST_UPDATED -Value $listUpdated.Trim(', ') | ||||||
| echo "UPDATE_MESSAGE<<<EOF`n$updateMessage`n<EOF" | Out-File -FilePath $env:GITHUB_ENV -Append -Encoding utf8 | ||||||
|
|
||||||
| - name: Summary - Update check results | ||||||
| shell: pwsh | ||||||
| run: | | ||||||
| $count = $env:COUNT_UPDATED | ||||||
| if ($count -eq 0) { | ||||||
| echo "### ✅ No Updates Available" >> $env:GITHUB_STEP_SUMMARY | ||||||
| echo "" >> $env:GITHUB_STEP_SUMMARY | ||||||
| echo "All vendor dependencies are up to date." >> $env:GITHUB_STEP_SUMMARY | ||||||
| } else { | ||||||
| $word = if ($count -eq 1) { 'dependency' } else { 'dependencies' } | ||||||
| echo "### 🔄 Updates Found" >> $env:GITHUB_STEP_SUMMARY | ||||||
| echo "" >> $env:GITHUB_STEP_SUMMARY | ||||||
| echo "**$count** vendor $word updated:" >> $env:GITHUB_STEP_SUMMARY | ||||||
| echo "" >> $env:GITHUB_STEP_SUMMARY | ||||||
| echo "$env:UPDATE_MESSAGE" >> $env:GITHUB_STEP_SUMMARY | ||||||
| echo "" >> $env:GITHUB_STEP_SUMMARY | ||||||
| } | ||||||
|
|
||||||
| - uses: peter-evans/create-pull-request@v7 | ||||||
| if: env.COUNT_UPDATED > 0 | ||||||
| with: | ||||||
|
|
@@ -63,3 +89,17 @@ jobs: | |||||
| commit-message: '⬆️ Update dependencies (${{ env.LIST_UPDATED }})' | ||||||
| branch: update-vendor | ||||||
| base: master | ||||||
|
|
||||||
| - name: Summary - Pull request created | ||||||
| if: env.COUNT_UPDATED > 0 | ||||||
| shell: pwsh | ||||||
| run: | | ||||||
| echo "### 🎉 Pull Request Created" >> $env:GITHUB_STEP_SUMMARY | ||||||
| echo "" >> $env:GITHUB_STEP_SUMMARY | ||||||
| echo "A pull request has been created to update the vendor dependencies." >> $env:GITHUB_STEP_SUMMARY | ||||||
| echo "" >> $env:GITHUB_STEP_SUMMARY | ||||||
| echo "**Branch:** \`update-vendor\`" >> $env:GITHUB_STEP_SUMMARY | ||||||
|
||||||
| echo "**Branch:** \`update-vendor\`" >> $env:GITHUB_STEP_SUMMARY | |
| echo "**Branch:** ``update-vendor``" >> $env:GITHUB_STEP_SUMMARY |
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.
Incorrect escape sequence for backticks in PowerShell. The syntax
\${{ ... }}`will output literal backslashes followed by backticks, not markdown-formatted code. In PowerShell, use doubled backticks to escape backticks: change`${{ github.repository }}`` to``${{ github.repository }}``, and similarly for the other GitHub Actions expressions on lines 51-52 and 54.