Skip to content

Commit d05d031

Browse files
DRSDavidSoftDRSDavidSoft
authored
Add GITHUB_STEP_SUMMARY to CI/CD workflows
2 parents 7368514 + 1509616 commit d05d031

File tree

5 files changed

+236
-0
lines changed

5 files changed

+236
-0
lines changed

‎.github/workflows/branches.yml‎

Lines changed: 27 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,15 @@ jobs:
3146
git checkout development
3247
git merge --no-ff master
3348
git push origin development
49+
50+
- name: Summary - Merge completed
51+
if: success()
52+
shell: bash
53+
run: |
54+
echo "### ✅ Merge Successful" >> $GITHUB_STEP_SUMMARY
55+
echo "" >> $GITHUB_STEP_SUMMARY
56+
echo "The \`master\` branch has been successfully merged into \`development\`." >> $GITHUB_STEP_SUMMARY
57+
echo "" >> $GITHUB_STEP_SUMMARY
58+
echo "**Merge type:** No fast-forward merge" >> $GITHUB_STEP_SUMMARY
59+
echo "" >> $GITHUB_STEP_SUMMARY
60+
echo "> The development branch is now synchronized with the latest changes from master." >> $GITHUB_STEP_SUMMARY

‎.github/workflows/build.yml‎

Lines changed: 72 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,40 @@ jobs:
4762
working-directory: scripts
4863
run: .\build.ps1 -Compile -verbose
4964

65+
- name: Summary - Build completed
66+
if: success()
67+
shell: pwsh
68+
run: |
69+
echo "### ✅ Build Status" >> $env:GITHUB_STEP_SUMMARY
70+
echo "" >> $env:GITHUB_STEP_SUMMARY
71+
echo "Cmder launcher successfully compiled." >> $env:GITHUB_STEP_SUMMARY
72+
echo "" >> $env:GITHUB_STEP_SUMMARY
73+
5074
- name: Pack the built files
5175
shell: pwsh
5276
working-directory: scripts
5377
run: .\pack.ps1 -verbose
5478

79+
- name: Summary - Package artifacts
80+
if: success()
81+
shell: pwsh
82+
run: |
83+
echo "### 📦 Artifacts Created" >> $env:GITHUB_STEP_SUMMARY
84+
echo "" >> $env:GITHUB_STEP_SUMMARY
85+
echo "| Artifact | Size | Hash (SHA256) |" >> $env:GITHUB_STEP_SUMMARY
86+
echo "| --- | --- | --- |" >> $env:GITHUB_STEP_SUMMARY
87+
$artifacts = @("cmder.zip", "cmder.7z", "cmder_mini.zip")
88+
foreach ($artifact in $artifacts) {
89+
$path = "build/$artifact"
90+
if (Test-Path $path) {
91+
$size = (Get-Item $path).Length / 1MB
92+
# Truncate hash to first 16 chars for summary readability (full hash in hashes.txt)
93+
$hash = (Get-FileHash $path -Algorithm SHA256).Hash.Substring(0, 16)
94+
echo "| \`$artifact\` | $([math]::Round($size, 2)) MB | \`$hash...\` |" >> $env:GITHUB_STEP_SUMMARY
95+
}
96+
}
97+
echo "" >> $env:GITHUB_STEP_SUMMARY
98+
5599
- name: Upload artifact (cmder.zip)
56100
uses: actions/upload-artifact@v5
57101
with:
@@ -77,6 +121,19 @@ jobs:
77121
path: build/hashes.txt
78122
name: hashes.txt
79123

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

‎.github/workflows/codeql.yml‎

Lines changed: 36 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,28 @@ jobs:
6782
working-directory: scripts
6883
run: .\build.ps1 -Compile -verbose
6984

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

‎.github/workflows/tests.yml‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,16 +39,77 @@ 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+
if: success()
64+
shell: pwsh
65+
run: |
66+
echo "### ⚙️ Vendor Initialization" >> $env:GITHUB_STEP_SUMMARY
67+
echo "" >> $env:GITHUB_STEP_SUMMARY
68+
echo "✅ Vendor dependencies initialized successfully." >> $env:GITHUB_STEP_SUMMARY
69+
echo "" >> $env:GITHUB_STEP_SUMMARY
70+
71+
- name: Summary - Test results table header
72+
if: success()
73+
shell: pwsh
74+
run: |
75+
echo "### 📋 Test Results" >> $env:GITHUB_STEP_SUMMARY
76+
echo "" >> $env:GITHUB_STEP_SUMMARY
77+
echo "| Test | Status |" >> $env:GITHUB_STEP_SUMMARY
78+
echo "| --- | --- |" >> $env:GITHUB_STEP_SUMMARY
79+
4680
- name: Testing Clink Shell
4781
run: |
4882
cmd /c vendor\init.bat /v /d /t
83+
84+
- name: Summary - Clink Shell test
85+
if: success()
86+
shell: pwsh
87+
run: |
88+
echo "| Clink Shell | ✅ Passed |" >> $env:GITHUB_STEP_SUMMARY
4989
- name: Testing PowerShell
5090
run: |
5191
PowerShell.exe -ExecutionPolicy Bypass -NoLogo -NoProfile -Command "$env:CMDER_DEBUG='1'; . 'vendor\profile.ps1'"
92+
93+
- name: Summary - PowerShell test
94+
if: success()
95+
shell: pwsh
96+
run: |
97+
echo "| PowerShell | ✅ Passed |" >> $env:GITHUB_STEP_SUMMARY
5298
- name: Testing Bash
5399
run: |
54100
bash vendor/cmder.sh
101+
102+
- name: Summary - Bash test
103+
if: success()
104+
shell: pwsh
105+
run: |
106+
echo "| Bash | ✅ Passed |" >> $env:GITHUB_STEP_SUMMARY
107+
108+
- name: Summary - All tests completed
109+
if: success()
110+
shell: pwsh
111+
run: |
112+
echo "" >> $env:GITHUB_STEP_SUMMARY
113+
echo "### ✅ All Tests Completed" >> $env:GITHUB_STEP_SUMMARY
114+
echo "" >> $env:GITHUB_STEP_SUMMARY
115+
echo "All shell environments tested successfully!" >> $env:GITHUB_STEP_SUMMARY

‎.github/workflows/vendor.yml‎

Lines changed: 40 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,24 @@ 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+
$word = if ($count -eq 1) { 'dependency' } else { 'dependencies' }
72+
echo "### 🔄 Updates Found" >> $env:GITHUB_STEP_SUMMARY
73+
echo "" >> $env:GITHUB_STEP_SUMMARY
74+
echo "**$count** vendor $word updated:" >> $env:GITHUB_STEP_SUMMARY
75+
echo "" >> $env:GITHUB_STEP_SUMMARY
76+
echo "$env:UPDATE_MESSAGE" >> $env:GITHUB_STEP_SUMMARY
77+
echo "" >> $env:GITHUB_STEP_SUMMARY
78+
}
79+
5480
- uses: peter-evans/create-pull-request@v7
5581
if: env.COUNT_UPDATED > 0
5682
with:
@@ -63,3 +89,17 @@ jobs:
6389
commit-message: '⬆️ Update dependencies (${{ env.LIST_UPDATED }})'
6490
branch: update-vendor
6591
base: master
92+
93+
- name: Summary - Pull request created
94+
if: env.COUNT_UPDATED > 0
95+
shell: pwsh
96+
run: |
97+
echo "### 🎉 Pull Request Created" >> $env:GITHUB_STEP_SUMMARY
98+
echo "" >> $env:GITHUB_STEP_SUMMARY
99+
echo "A pull request has been created to update the vendor dependencies." >> $env:GITHUB_STEP_SUMMARY
100+
echo "" >> $env:GITHUB_STEP_SUMMARY
101+
echo "**Branch:** \`update-vendor\`" >> $env:GITHUB_STEP_SUMMARY
102+
echo "" >> $env:GITHUB_STEP_SUMMARY
103+
echo "**Updated dependencies:** $env:LIST_UPDATED" >> $env:GITHUB_STEP_SUMMARY
104+
echo "" >> $env:GITHUB_STEP_SUMMARY
105+
echo "> Please review and merge the pull request to apply the updates." >> $env:GITHUB_STEP_SUMMARY

0 commit comments

Comments
 (0)