Skip to content

Commit 0db2dbf

Browse files
CopilotDRSDavidSoft
Copilot
and
DRSDavidSoft
committed
Add GITHUB_STEP_SUMMARY to all CI/CD workflows
Co-authored-by: DRSDavidSoft <4673812+DRSDavidSoft@users.noreply.github.com>
1 parent d285f63 commit 0db2dbf

5 files changed

Lines changed: 219 additions & 0 deletions

File tree

‎.github/workflows/branches.yml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,21 @@ jobs:
2323
with:
2424
fetch-depth: 0 # fetch all history for all branches and tags
2525

26+
- name: Summary - Merge operation started
27+
shell: bash
28+
run: |
29+
echo "## 🔀 Update Branches - Workflow Summary" >> $GITHUB_STEP_SUMMARY
30+
echo "" >> $GITHUB_STEP_SUMMARY
31+
echo "### Merge Operation" >> $GITHUB_STEP_SUMMARY
32+
echo "" >> $GITHUB_STEP_SUMMARY
33+
echo "| Property | Value |" >> $GITHUB_STEP_SUMMARY
34+
echo "| --- | --- |" >> $GITHUB_STEP_SUMMARY
35+
echo "| Source Branch | \`master\` |" >> $GITHUB_STEP_SUMMARY
36+
echo "| Target Branch | \`development\` |" >> $GITHUB_STEP_SUMMARY
37+
echo "| Triggered by | @${{ github.actor }} |" >> $GITHUB_STEP_SUMMARY
38+
echo "| Commit | \`${{ github.sha }}\` |" >> $GITHUB_STEP_SUMMARY
39+
echo "" >> $GITHUB_STEP_SUMMARY
40+
2641
# Runs a single command using the runners shell
2742
- name: Merge master into development
2843
run: |
@@ -31,3 +46,14 @@ jobs:
3146
git checkout development
3247
git merge --no-ff master
3348
git push origin development
49+
50+
- name: Summary - Merge completed
51+
shell: bash
52+
run: |
53+
echo "### ✅ Merge Successful" >> $GITHUB_STEP_SUMMARY
54+
echo "" >> $GITHUB_STEP_SUMMARY
55+
echo "The \`master\` branch has been successfully merged into \`development\`." >> $GITHUB_STEP_SUMMARY
56+
echo "" >> $GITHUB_STEP_SUMMARY
57+
echo "**Merge type:** No fast-forward merge" >> $GITHUB_STEP_SUMMARY
58+
echo "" >> $GITHUB_STEP_SUMMARY
59+
echo "> The development branch is now synchronized with the latest changes from master." >> $GITHUB_STEP_SUMMARY

‎.github/workflows/build.yml‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,21 @@ jobs:
3939
with:
4040
fetch-depth: 0
4141

42+
- name: Summary - Repository checkout
43+
shell: pwsh
44+
run: |
45+
echo "## 📦 Build Cmder - Workflow Summary" >> $env:GITHUB_STEP_SUMMARY
46+
echo "" >> $env:GITHUB_STEP_SUMMARY
47+
echo "### Repository Information" >> $env:GITHUB_STEP_SUMMARY
48+
echo "| Property | Value |" >> $env:GITHUB_STEP_SUMMARY
49+
echo "| --- | --- |" >> $env:GITHUB_STEP_SUMMARY
50+
echo "| Repository | \`${{ github.repository }}\` |" >> $env:GITHUB_STEP_SUMMARY
51+
echo "| Branch | \`${{ github.ref_name }}\` |" >> $env:GITHUB_STEP_SUMMARY
52+
echo "| Commit | \`${{ github.sha }}\` |" >> $env:GITHUB_STEP_SUMMARY
53+
echo "| Actor | @${{ github.actor }} |" >> $env:GITHUB_STEP_SUMMARY
54+
echo "| Workflow | \`${{ github.workflow }}\` |" >> $env:GITHUB_STEP_SUMMARY
55+
echo "" >> $env:GITHUB_STEP_SUMMARY
56+
4257
- name: Add MSBuild to PATH
4358
uses: microsoft/setup-msbuild@v2
4459

@@ -47,11 +62,43 @@ jobs:
4762
working-directory: scripts
4863
run: .\build.ps1 -Compile -verbose
4964

65+
- name: Summary - Build completed
66+
shell: pwsh
67+
run: |
68+
echo "### ✅ Build Status" >> $env:GITHUB_STEP_SUMMARY
69+
echo "" >> $env:GITHUB_STEP_SUMMARY
70+
echo "Cmder launcher successfully compiled." >> $env:GITHUB_STEP_SUMMARY
71+
echo "" >> $env:GITHUB_STEP_SUMMARY
72+
5073
- name: Pack the built files
5174
shell: pwsh
5275
working-directory: scripts
5376
run: .\pack.ps1 -verbose
5477

78+
- name: Summary - Package artifacts
79+
shell: pwsh
80+
run: |
81+
echo "### 📦 Artifacts Created" >> $env:GITHUB_STEP_SUMMARY
82+
echo "" >> $env:GITHUB_STEP_SUMMARY
83+
echo "| Artifact | Size | Hash (SHA256) |" >> $env:GITHUB_STEP_SUMMARY
84+
echo "| --- | --- | --- |" >> $env:GITHUB_STEP_SUMMARY
85+
if (Test-Path "build/cmder.zip") {
86+
$size = (Get-Item "build/cmder.zip").Length / 1MB
87+
$hash = (Get-FileHash "build/cmder.zip" -Algorithm SHA256).Hash.Substring(0, 16)
88+
echo "| \`cmder.zip\` | $([math]::Round($size, 2)) MB | \`$hash...\` |" >> $env:GITHUB_STEP_SUMMARY
89+
}
90+
if (Test-Path "build/cmder.7z") {
91+
$size = (Get-Item "build/cmder.7z").Length / 1MB
92+
$hash = (Get-FileHash "build/cmder.7z" -Algorithm SHA256).Hash.Substring(0, 16)
93+
echo "| \`cmder.7z\` | $([math]::Round($size, 2)) MB | \`$hash...\` |" >> $env:GITHUB_STEP_SUMMARY
94+
}
95+
if (Test-Path "build/cmder_mini.zip") {
96+
$size = (Get-Item "build/cmder_mini.zip").Length / 1MB
97+
$hash = (Get-FileHash "build/cmder_mini.zip" -Algorithm SHA256).Hash.Substring(0, 16)
98+
echo "| \`cmder_mini.zip\` | $([math]::Round($size, 2)) MB | \`$hash...\` |" >> $env:GITHUB_STEP_SUMMARY
99+
}
100+
echo "" >> $env:GITHUB_STEP_SUMMARY
101+
55102
- name: Upload artifact (cmder.zip)
56103
uses: actions/upload-artifact@v5
57104
with:
@@ -77,6 +124,18 @@ jobs:
77124
path: build/hashes.txt
78125
name: hashes.txt
79126

127+
- name: Summary - Artifacts uploaded
128+
shell: pwsh
129+
run: |
130+
echo "### ☁️ Upload Status" >> $env:GITHUB_STEP_SUMMARY
131+
echo "" >> $env:GITHUB_STEP_SUMMARY
132+
echo "All artifacts successfully uploaded to GitHub Actions:" >> $env:GITHUB_STEP_SUMMARY
133+
echo "- ✅ \`cmder.zip\`" >> $env:GITHUB_STEP_SUMMARY
134+
echo "- ✅ \`cmder.7z\`" >> $env:GITHUB_STEP_SUMMARY
135+
echo "- ✅ \`cmder_mini.zip\`" >> $env:GITHUB_STEP_SUMMARY
136+
echo "- ✅ \`hashes.txt\`" >> $env:GITHUB_STEP_SUMMARY
137+
echo "" >> $env:GITHUB_STEP_SUMMARY
138+
80139
- name: Create Release
81140
uses: softprops/action-gh-release@v2
82141
with:
@@ -88,3 +147,18 @@ jobs:
88147
draft: true
89148
generate_release_notes: true
90149
if: startsWith(github.ref, 'refs/tags/')
150+
151+
- name: Summary - Release created
152+
if: startsWith(github.ref, 'refs/tags/')
153+
shell: pwsh
154+
run: |
155+
echo "### 🚀 Release Information" >> $env:GITHUB_STEP_SUMMARY
156+
echo "" >> $env:GITHUB_STEP_SUMMARY
157+
echo "Draft release created for tag: **\`${{ github.ref_name }}\`**" >> $env:GITHUB_STEP_SUMMARY
158+
echo "" >> $env:GITHUB_STEP_SUMMARY
159+
echo "Release includes:" >> $env:GITHUB_STEP_SUMMARY
160+
echo "- Full version (\`cmder.zip\`, \`cmder.7z\`)" >> $env:GITHUB_STEP_SUMMARY
161+
echo "- Mini version (\`cmder_mini.zip\`)" >> $env:GITHUB_STEP_SUMMARY
162+
echo "- File hashes (\`hashes.txt\`)" >> $env:GITHUB_STEP_SUMMARY
163+
echo "" >> $env:GITHUB_STEP_SUMMARY
164+
echo "> ⚠️ Release is in **draft** mode. Please review and publish manually." >> $env:GITHUB_STEP_SUMMARY

‎.github/workflows/codeql.yml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,21 @@ jobs:
4747
- name: Checkout repository
4848
uses: actions/checkout@v6
4949

50+
- name: Summary - CodeQL analysis started
51+
shell: pwsh
52+
run: |
53+
echo "## 🔒 CodeQL Security Analysis - Workflow Summary" >> $env:GITHUB_STEP_SUMMARY
54+
echo "" >> $env:GITHUB_STEP_SUMMARY
55+
echo "### Analysis Configuration" >> $env:GITHUB_STEP_SUMMARY
56+
echo "" >> $env:GITHUB_STEP_SUMMARY
57+
echo "| Property | Value |" >> $env:GITHUB_STEP_SUMMARY
58+
echo "| --- | --- |" >> $env:GITHUB_STEP_SUMMARY
59+
echo "| Repository | \`${{ github.repository }}\` |" >> $env:GITHUB_STEP_SUMMARY
60+
echo "| Branch | \`${{ github.ref_name }}\` |" >> $env:GITHUB_STEP_SUMMARY
61+
echo "| Language | \`${{ matrix.language }}\` |" >> $env:GITHUB_STEP_SUMMARY
62+
echo "| Commit | \`${{ github.sha }}\` |" >> $env:GITHUB_STEP_SUMMARY
63+
echo "" >> $env:GITHUB_STEP_SUMMARY
64+
5065
# Initializes the CodeQL tools for scanning.
5166
- name: Initialize CodeQL
5267
uses: github/codeql-action/init@v4
@@ -67,7 +82,26 @@ jobs:
6782
working-directory: scripts
6883
run: .\build.ps1 -Compile -verbose
6984

85+
- name: Summary - Build status
86+
shell: pwsh
87+
run: |
88+
echo "### ✅ Build Completed" >> $env:GITHUB_STEP_SUMMARY
89+
echo "" >> $env:GITHUB_STEP_SUMMARY
90+
echo "Cmder launcher built successfully for CodeQL analysis." >> $env:GITHUB_STEP_SUMMARY
91+
echo "" >> $env:GITHUB_STEP_SUMMARY
92+
7093
- name: Perform CodeQL Analysis
7194
uses: github/codeql-action/analyze@v4
7295
with:
7396
category: "/language:${{matrix.language}}"
97+
98+
- name: Summary - Analysis completed
99+
shell: pwsh
100+
run: |
101+
echo "### 🔍 CodeQL Analysis Results" >> $env:GITHUB_STEP_SUMMARY
102+
echo "" >> $env:GITHUB_STEP_SUMMARY
103+
echo "✅ CodeQL security analysis completed successfully." >> $env:GITHUB_STEP_SUMMARY
104+
echo "" >> $env:GITHUB_STEP_SUMMARY
105+
echo "**Language analyzed:** \`${{ matrix.language }}\`" >> $env:GITHUB_STEP_SUMMARY
106+
echo "" >> $env:GITHUB_STEP_SUMMARY
107+
echo "> Check the Security tab for detailed findings and recommendations." >> $env:GITHUB_STEP_SUMMARY

‎.github/workflows/tests.yml‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,16 +39,62 @@ jobs:
3939

4040
steps:
4141
- uses: actions/checkout@v6
42+
43+
- name: Summary - Test execution started
44+
shell: pwsh
45+
run: |
46+
echo "## 🧪 Run Tests - Workflow Summary" >> $env:GITHUB_STEP_SUMMARY
47+
echo "" >> $env:GITHUB_STEP_SUMMARY
48+
echo "### Test Environment" >> $env:GITHUB_STEP_SUMMARY
49+
echo "| Property | Value |" >> $env:GITHUB_STEP_SUMMARY
50+
echo "| --- | --- |" >> $env:GITHUB_STEP_SUMMARY
51+
echo "| Repository | \`${{ github.repository }}\` |" >> $env:GITHUB_STEP_SUMMARY
52+
echo "| Branch | \`${{ github.ref_name }}\` |" >> $env:GITHUB_STEP_SUMMARY
53+
echo "| Commit | \`${{ github.sha }}\` |" >> $env:GITHUB_STEP_SUMMARY
54+
echo "| Runner OS | \`${{ runner.os }}\` |" >> $env:GITHUB_STEP_SUMMARY
55+
echo "" >> $env:GITHUB_STEP_SUMMARY
56+
4257
- name: Initialize vendors
4358
shell: pwsh
4459
working-directory: scripts
4560
run: .\build.ps1 -verbose
61+
62+
- name: Summary - Vendor initialization
63+
shell: pwsh
64+
run: |
65+
echo "### ⚙️ Vendor Initialization" >> $env:GITHUB_STEP_SUMMARY
66+
echo "" >> $env:GITHUB_STEP_SUMMARY
67+
echo "✅ Vendor dependencies initialized successfully." >> $env:GITHUB_STEP_SUMMARY
68+
echo "" >> $env:GITHUB_STEP_SUMMARY
69+
echo "### 📋 Test Results" >> $env:GITHUB_STEP_SUMMARY
70+
echo "" >> $env:GITHUB_STEP_SUMMARY
71+
echo "| Test | Status |" >> $env:GITHUB_STEP_SUMMARY
72+
echo "| --- | --- |" >> $env:GITHUB_STEP_SUMMARY
4673
- name: Testing Clink Shell
4774
run: |
4875
cmd /c vendor\init.bat /v /d /t
76+
77+
- name: Summary - Clink Shell test
78+
shell: pwsh
79+
run: |
80+
echo "| Clink Shell | ✅ Passed |" >> $env:GITHUB_STEP_SUMMARY
4981
- name: Testing PowerShell
5082
run: |
5183
PowerShell.exe -ExecutionPolicy Bypass -NoLogo -NoProfile -Command "$env:CMDER_DEBUG='1'; . 'vendor\profile.ps1'"
84+
85+
- name: Summary - PowerShell test
86+
shell: pwsh
87+
run: |
88+
echo "| PowerShell | ✅ Passed |" >> $env:GITHUB_STEP_SUMMARY
5289
- name: Testing Bash
5390
run: |
5491
bash vendor/cmder.sh
92+
93+
- name: Summary - Bash test
94+
shell: pwsh
95+
run: |
96+
echo "| Bash | ✅ Passed |" >> $env:GITHUB_STEP_SUMMARY
97+
echo "" >> $env:GITHUB_STEP_SUMMARY
98+
echo "### ✅ All Tests Completed" >> $env:GITHUB_STEP_SUMMARY
99+
echo "" >> $env:GITHUB_STEP_SUMMARY
100+
echo "All shell environments tested successfully!" >> $env:GITHUB_STEP_SUMMARY

‎.github/workflows/vendor.yml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,14 @@ jobs:
2828
with:
2929
fetch-depth: 0
3030

31+
- name: Summary - Workflow started
32+
shell: pwsh
33+
run: |
34+
echo "## 📦 Update Vendor - Workflow Summary" >> $env:GITHUB_STEP_SUMMARY
35+
echo "" >> $env:GITHUB_STEP_SUMMARY
36+
echo "Checking for vendor dependency updates..." >> $env:GITHUB_STEP_SUMMARY
37+
echo "" >> $env:GITHUB_STEP_SUMMARY
38+
3139
- id: make-changes
3240
name: Checking for updates
3341
env:
@@ -51,6 +59,23 @@ jobs:
5159
Set-GHVariable -Name LIST_UPDATED -Value $listUpdated.Trim(', ')
5260
echo "UPDATE_MESSAGE<<<EOF`n$updateMessage`n<EOF" | Out-File -FilePath $env:GITHUB_ENV -Append -Encoding utf8
5361
62+
- name: Summary - Update check results
63+
shell: pwsh
64+
run: |
65+
$count = $env:COUNT_UPDATED
66+
if ($count -eq 0) {
67+
echo "### ✅ No Updates Available" >> $env:GITHUB_STEP_SUMMARY
68+
echo "" >> $env:GITHUB_STEP_SUMMARY
69+
echo "All vendor dependencies are up to date." >> $env:GITHUB_STEP_SUMMARY
70+
} else {
71+
echo "### 🔄 Updates Found" >> $env:GITHUB_STEP_SUMMARY
72+
echo "" >> $env:GITHUB_STEP_SUMMARY
73+
echo "**$count** vendor dependenc$(if ($count -eq 1) { 'y' } else { 'ies' }) updated:" >> $env:GITHUB_STEP_SUMMARY
74+
echo "" >> $env:GITHUB_STEP_SUMMARY
75+
echo "$env:UPDATE_MESSAGE" >> $env:GITHUB_STEP_SUMMARY
76+
echo "" >> $env:GITHUB_STEP_SUMMARY
77+
}
78+
5479
- uses: peter-evans/create-pull-request@v7
5580
if: env.COUNT_UPDATED > 0
5681
with:
@@ -63,3 +88,17 @@ jobs:
6388
commit-message: '⬆️ Update dependencies (${{ env.LIST_UPDATED }})'
6489
branch: update-vendor
6590
base: master
91+
92+
- name: Summary - Pull request created
93+
if: env.COUNT_UPDATED > 0
94+
shell: pwsh
95+
run: |
96+
echo "### 🎉 Pull Request Created" >> $env:GITHUB_STEP_SUMMARY
97+
echo "" >> $env:GITHUB_STEP_SUMMARY
98+
echo "A pull request has been created to update the vendor dependencies." >> $env:GITHUB_STEP_SUMMARY
99+
echo "" >> $env:GITHUB_STEP_SUMMARY
100+
echo "**Branch:** \`update-vendor\`" >> $env:GITHUB_STEP_SUMMARY
101+
echo "" >> $env:GITHUB_STEP_SUMMARY
102+
echo "**Updated dependencies:** $env:LIST_UPDATED" >> $env:GITHUB_STEP_SUMMARY
103+
echo "" >> $env:GITHUB_STEP_SUMMARY
104+
echo "> Please review and merge the pull request to apply the updates." >> $env:GITHUB_STEP_SUMMARY

0 commit comments

Comments
 (0)