Skip to content

feat: Extend changelog generation to show release note category and target_group #48

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.

Sign up for GitHub

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 1 commit into from
Jul 24, 2025
Merged

feat: Extend changelog generation to show release note category and target_group #48

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 18 additions & 11 deletions generate-changelog.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,23 +49,30 @@ for PR_NUMBER in $PR_COMMITS; do
continue
fi

TITLE=$(echo "$PR_JSON" | jq -r '.title')
URL=$(echo "$PR_JSON" | jq -r '.url')
BODY=$(echo "$PR_JSON" | jq -r '.body')
PR_TITLE=$(echo "$PR_JSON" | jq -r '.title')
PR_URL=$(echo "$PR_JSON" | jq -r '.url')
PR_BODY=$(echo "$PR_JSON" | jq -r '.body')

# Determine type from conventional commit (assumes title like "type(scope): message" or "type: message")
TYPE=$(echo "$TITLE" | grep -oE '^[a-z]+' || echo "feat")
CLEAN_TITLE=$(echo "$TITLE" | sed -E 's/^[a-z]+(\([^)]+\))?(!)?:[[:space:]]+//')
TYPE=$(echo "$PR_TITLE" | grep -oE '^[a-z]+' || echo "feat")
CLEAN_TITLE=$(echo "$PR_TITLE" | sed -E 's/^[a-z]+(\([^)]+\))?(!)?:[[:space:]]+//')

# Extract release note block, this contains the release notes and the release notes headers.
RELEASE_NOTE_BLOCK=$(echo "$PR_BODY" | sed -n '/\*\*Release note\*\*:/,$p' | sed -n '/^```.*$/,/^```$/p')
# Extract release notes body
RELEASE_NOTE=$(echo "$RELEASE_NOTE_BLOCK" | sed '1d;$d' | sed -e 's/^[[:space:]]*//' -e 's/[[:space:]]*$//')

# Extract release note block, we only extract the "user" related notes.
RELEASE_NOTE=$(echo "$BODY" | awk '/^```[[:space:]]*(breaking|feature|bugfix|doc|other)[[:space:]]+user[[:space:]]*$/ {flag=1; next} /^```[[:space:]]*$/ {flag=0} flag' | grep -v 'NONE' || true)
# Format entry
ENTRY="- $CLEAN_TITLE [#${PR_NUMBER}](${URL})"
ENTRY="- $CLEAN_TITLE [#${PR_NUMBER}](${PR_URL})"

if [[ -n "$RELEASE_NOTE" ]]; then
ENTRY+=": $RELEASE_NOTE"
else
if [[ -z "$RELEASE_NOTE" || "$RELEASE_NOTE" == "NONE" ]]; then
ENTRY+="."
else
# Extract and format the release note headers.
HEADERS=$(echo "$PR_BODY" | sed -n '/\*\*Release note\*\*:/,$p' | sed -n '/^```.*$/,/^```$/p'| head -n 1 | sed 's/^```//')
FORMATED_HEADERS=$(echo "$HEADERS" | sed 's/^[[:space:]]*//; s/[[:space:]]*$//; s/\s\+/ /g' | sed 's/\(\S\+\)/[\1]/g')

ENTRY="- ${FORMATED_HEADERS} ${CLEAN_TITLE} [#${PR_NUMBER}](${PR_URL}): ${RELEASE_NOTE}"
fi
ENTRY+="\n"

Expand Down