Files
Pulse/scripts/generate-release-notes.sh
rcourtman 583d21bdf9 Fix commit hash linking in release notes
Remove # symbol from commit hash references so GitHub auto-links them.
Format: (abc123) instead of (#abc123)
Issue references still use #: (#123)

Related to #671
2025-11-11 17:03:39 +00:00

206 lines
6.4 KiB
Bash
Executable File

#!/usr/bin/env bash
# Generate release notes using LLM analysis of git commits
# Usage: ./scripts/generate-release-notes.sh <version> [previous-tag]
set -euo pipefail
VERSION=${1:-}
PREVIOUS_TAG=${2:-}
if [ -z "$VERSION" ]; then
echo "Usage: $0 <version> [previous-tag]"
echo "Example: $0 4.29.0 v4.28.0"
exit 1
fi
# Find previous tag if not specified
if [ -z "$PREVIOUS_TAG" ]; then
PREVIOUS_TAG=$(git describe --tags --abbrev=0 2>/dev/null || echo "")
if [ -z "$PREVIOUS_TAG" ]; then
echo "No previous tag found, using all commits"
PREVIOUS_TAG=$(git rev-list --max-parents=0 HEAD)
fi
fi
echo "Generating release notes for v${VERSION}..."
echo "Analyzing commits since ${PREVIOUS_TAG}..."
# Get commit log
COMMIT_LOG=$(git log ${PREVIOUS_TAG}..HEAD --pretty=format:"%h %s" --no-merges)
if [ -z "$COMMIT_LOG" ]; then
echo "No commits found since ${PREVIOUS_TAG}"
exit 1
fi
# Count commits
COMMIT_COUNT=$(echo "$COMMIT_LOG" | wc -l)
echo "Found ${COMMIT_COUNT} commits"
# Generate release notes using LLM API
# Supports both OpenAI and Anthropic Claude
# Set either OPENAI_API_KEY or ANTHROPIC_API_KEY
if [ -n "${ANTHROPIC_API_KEY:-}" ]; then
LLM_PROVIDER="anthropic"
elif [ -n "${OPENAI_API_KEY:-}" ]; then
LLM_PROVIDER="openai"
else
echo "Error: Either OPENAI_API_KEY or ANTHROPIC_API_KEY environment variable must be set"
exit 1
fi
echo "Using LLM provider: ${LLM_PROVIDER}"
# Prepare prompt for LLM
read -r -d '' PROMPT <<EOF || true
You are generating release notes for Pulse v${VERSION}.
Pulse is a monitoring system for Proxmox VE and PBS with Docker container monitoring capabilities.
Analyze the following ${COMMIT_COUNT} git commits and generate professional release notes:
${COMMIT_LOG}
Generate release notes following this EXACT template format:
## What's Changed
### New Features
[List new features as bullet points, each starting with "**Feature name**:" followed by description and commit hash in parentheses like (abc123)]
### Bug Fixes
[List bug fixes as bullet points, each starting with "**Component/area**:" followed by description and issue/commit reference like (#123) for issues or (abc123) for commits]
### Improvements
[List improvements/enhancements as bullet points, each starting with "**Component/area**:" followed by description and commit hash like (abc123)]
### Breaking Changes
[List any breaking changes, or write "None" if there are none]
## Installation
**Quick Install (systemd / LXC / Proxmox VE):**
\`\`\`bash
curl -fsSL https://raw.githubusercontent.com/rcourtman/Pulse/main/install.sh | bash
\`\`\`
**Docker:**
\`\`\`bash
docker pull rcourtman/pulse:v${VERSION}
docker stop pulse && docker rm pulse
docker run -d --name pulse \\
--restart unless-stopped \\
-p 7655:7655 -p 7656:7656 \\
-v /opt/pulse/data:/data \\
rcourtman/pulse:v${VERSION}
\`\`\`
**Manual Binary (amd64 example):**
\`\`\`bash
curl -LO https://github.com/rcourtman/Pulse/releases/download/v${VERSION}/pulse-v${VERSION}-linux-amd64.tar.gz
sudo systemctl stop pulse
sudo tar -xzf pulse-v${VERSION}-linux-amd64.tar.gz -C /usr/local/bin pulse
sudo systemctl start pulse
\`\`\`
**Helm:**
\`\`\`bash
helm upgrade --install pulse oci://ghcr.io/rcourtman/pulse-chart \\
--version ${VERSION} \\
--namespace pulse \\
--create-namespace
\`\`\`
## Downloads
- Universal tarball (auto-detects architecture): \`pulse-v${VERSION}.tar.gz\`
- Architecture-specific: \`amd64\`, \`arm64\`, \`armv7\`, \`armv6\`, \`386\`
- Host agent packages: macOS (amd64/arm64), Windows (amd64/arm64/386), Linux (amd64/arm64/armv7/armv6/386)
- Sensor proxy: Linux (amd64/arm64/armv7/armv6/386)
- Helm chart: \`pulse-${VERSION}.tgz\`
- SHA256 checksums: \`checksums.txt\`
## Notes
[Add 2-4 bullet points highlighting the most important changes, configuration notes, or upgrade considerations. Keep this section concise and actionable.]
Guidelines:
- Match the exact format and style of the template above
- Use bold for feature/component names followed by colon
- Include commit hashes WITHOUT # symbol - just the hash like (abc123) not (#abc123)
- GitHub will auto-link commit hashes when they appear in parentheses
- For issue references, use # like (#123)
- Focus on user-visible changes only
- Use clear, non-technical language
- Group related changes together logically
- If there are no breaking changes, write "None" in that section
- Keep the Notes section practical and actionable
EOF
# Call LLM API based on provider
if [ "$LLM_PROVIDER" = "anthropic" ]; then
RESPONSE=$(curl -s https://api.anthropic.com/v1/messages \
-H "Content-Type: application/json" \
-H "x-api-key: ${ANTHROPIC_API_KEY}" \
-H "anthropic-version: 2023-06-01" \
-d @- <<JSON
{
"model": "claude-haiku-4-5-20251001",
"max_tokens": 2000,
"system": "You are a technical writer creating release notes. Be concise, clear, and focus on user-visible changes. Use proper markdown formatting.",
"messages": [
{
"role": "user",
"content": $(echo "$PROMPT" | jq -Rs .)
}
]
}
JSON
)
RELEASE_NOTES=$(echo "$RESPONSE" | jq -r '.content[0].text')
else
RESPONSE=$(curl -s https://api.openai.com/v1/chat/completions \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${OPENAI_API_KEY}" \
-d @- <<JSON
{
"model": "gpt-4o-mini",
"messages": [
{
"role": "system",
"content": "You are a technical writer creating release notes. Be concise, clear, and focus on user-visible changes. Use proper markdown formatting."
},
{
"role": "user",
"content": $(echo "$PROMPT" | jq -Rs .)
}
],
"temperature": 0.7,
"max_tokens": 2000
}
JSON
)
RELEASE_NOTES=$(echo "$RESPONSE" | jq -r '.choices[0].message.content')
fi
if [ -z "$RELEASE_NOTES" ] || [ "$RELEASE_NOTES" = "null" ]; then
echo "Error: Failed to generate release notes"
echo "API Response: $RESPONSE"
exit 1
fi
# Output release notes
echo ""
echo "Generated release notes:"
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
echo "$RELEASE_NOTES"
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
# Optionally save to file
if [ "${SAVE_TO_FILE:-}" = "1" ]; then
OUTPUT_FILE="release-notes-v${VERSION}.md"
echo "$RELEASE_NOTES" > "$OUTPUT_FILE"
echo ""
echo "Saved to: $OUTPUT_FILE"
fi