Skip to content

Commit 4492c9d

Browse files
committed
Improve release notes: commit links, remove install info
Updated release.yml to link commits in release notes using short hashes and full commit URLs, removed author mentions, and eliminated the installation instructions section for a cleaner output. #10
1 parent 0c1b656 commit 4492c9d

1 file changed

Lines changed: 8 additions & 25 deletions

File tree

‎.github/workflows/release.yml‎

Lines changed: 8 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -179,8 +179,9 @@ jobs:
179179
180180
# ── Collect commits by conventional-commit prefix ────────────────────
181181
# Write raw log to a temp file so grep never sees an empty pipe
182+
# Format: subject|short-hash|full-hash (no author — git name ≠ GitHub username)
182183
RAW_LOG=$(mktemp)
183-
git log "$RANGE" --pretty="format:%s|%h|%an" > "$RAW_LOG" || true
184+
git log "$RANGE" --pretty="format:%s|%h|%H" > "$RAW_LOG" || true
184185
185186
set +o pipefail
186187
BREAKING=$(grep -iE "^[a-z]+(\(.+\))?!:" "$RAW_LOG" || true)
@@ -192,16 +193,18 @@ jobs:
192193
193194
rm -f "$RAW_LOG"
194195
196+
REPO_URL="https://github.com/${{ github.repository }}"
197+
195198
# ── Helper: emit a markdown section from pipe-delimited commit lines ─
196199
format_section() {
197200
local title="$1"
198201
local items="$2"
199202
[ -z "$items" ] && return
200203
echo "### ${title}"
201204
echo ""
202-
while IFS='|' read -r subject hash author; do
205+
while IFS='|' read -r subject shorthash fullhash; do
203206
[ -z "$subject" ] && continue
204-
echo "- ${subject} (\`${hash}\`) — @${author}"
207+
echo "- ${subject} ([${shorthash}](${REPO_URL}/commit/${fullhash}))"
205208
done <<< "$items"
206209
echo ""
207210
}
@@ -219,15 +222,14 @@ jobs:
219222
echo "| **Commits** | ${COMMIT_COUNT} since \`${PREV_LABEL}\` |"
220223
echo "| **Full diff** | [${{ github.repository }}](${DIFF_URL}) |"
221224
echo ""
222-
echo "---"
223225
echo ""
224226
225227
if [ -n "$BREAKING" ]; then
226228
echo "### ⚠️ Breaking Changes"
227229
echo ""
228-
while IFS='|' read -r subject hash author; do
230+
while IFS='|' read -r subject shorthash fullhash; do
229231
[ -z "$subject" ] && continue
230-
echo "- ${subject} (\`${hash}\`) — @${author}"
232+
echo "- ${subject} ([${shorthash}](${REPO_URL}/commit/${fullhash}))"
231233
done <<< "$BREAKING"
232234
echo ""
233235
fi
@@ -236,25 +238,6 @@ jobs:
236238
format_section "🐛 Bug Fixes" "$FIXES"
237239
format_section "⚡ Performance" "$PERF"
238240
format_section "🔀 Other Changes" "$OTHERS"
239-
240-
echo "---"
241-
echo ""
242-
echo "### 📦 Installation"
243-
echo ""
244-
echo "Download the archive for your platform from the assets below,"
245-
echo "verify its checksum, then extract."
246-
echo ""
247-
echo '```bash'
248-
echo "# Linux / macOS"
249-
echo "sha256sum -c vectractl-<platform>-<arch>.tar.gz.sha256"
250-
echo "tar -xzf vectractl-<platform>-<arch>.tar.gz"
251-
echo '```'
252-
echo ""
253-
echo '```powershell'
254-
echo "# Windows (PowerShell)"
255-
echo "Get-FileHash vectractl-windows-x64.zip -Algorithm SHA256"
256-
echo "Expand-Archive vectractl-windows-x64.zip"
257-
echo '```'
258241
} > release_notes.md
259242
260243
echo "Release notes written ($(wc -l < release_notes.md) lines)"

0 commit comments

Comments
 (0)