Skip to content

Commit e2d2e17

Browse files
feat(release): tighten generated release notes
- Ask communique for at most 1200 characters and 5 bullets, so the Discord post reads as a short announcement. - Stop crediting the maintainer and bots on every bullet. Other contributors are still credited once. - Put the raw commit list in a collapsed <details> block, so the generated notes stay in front. GitHub, Modrinth, and Hangar all render it. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
1 parent 885c7cd commit e2d2e17

2 files changed

Lines changed: 3 additions & 2 deletions

File tree

‎.github/workflows/release.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ jobs:
137137
communique generate "$RELEASE_TAG" --tag-pattern '[0-9]*' --output "$RUNNER_TEMP/communique.md"
138138
# Drop the generated "# <tag>: <title>" heading because each release keeps its own name.
139139
sed '1{/^# /d}' "$RUNNER_TEMP/communique.md" | sed '/./,$!d' > "$RUNNER_TEMP/release-highlights.md"
140-
printf '\n\n## Commits\n\n%s\n' "$COMMIT_CHANGELOG" | cat "$RUNNER_TEMP/release-highlights.md" - > "$RUNNER_TEMP/release-notes.md"
140+
printf '\n\n<details>\n<summary>All commits</summary>\n\n%s\n\n</details>\n' "$COMMIT_CHANGELOG" | cat "$RUNNER_TEMP/release-highlights.md" - > "$RUNNER_TEMP/release-notes.md"
141141
python3 - "$RUNNER_TEMP/release-highlights.md" "$RELEASE_URL" > "$RUNNER_TEMP/discord.md" <<'PY'
142142
import re, sys
143143
# Show headings as bold text and keep the embed within Discord's 4096-character limit.

‎communique.toml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ PistonQueue is a queue plugin for survival and anarchy Minecraft networks. It ru
77

88
system_extra = """
99
Write for the people who install and run PistonQueue, not for contributors.
10-
Keep release_body short. It is also posted to Discord, which cuts embeds at 4096 characters, so aim for under 2500 characters.
10+
Keep release_body under 1200 characters with at most 5 bullet points in total. It is also posted to Discord as a chat announcement.
11+
Do not credit AlexProgrammerDE or bots such as dependabot and renovate, because they are the maintainer and automation. Credit other contributors once, in their bullet or in New Contributors.
1112
Describe what users can now do or what works better. Skip tests, CI, formatting, dependency bumps, and internal refactors unless users notice the change.
1213
Do not invent speed, reliability, security, or compatibility claims.
1314
Do not use emoji or em dashes.

0 commit comments

Comments
 (0)