Skip to content

v1.1.1: Less repetitive release notes#125

Merged
jdx merged 1 commit intomainfrom
release-plz-2026-04-26T13-38-17Z
Apr 26, 2026
Merged

v1.1.1: Less repetitive release notes#125
jdx merged 1 commit intomainfrom
release-plz-2026-04-26T13-38-17Z

Conversation

@jdx
Copy link
Copy Markdown
Owner

@jdx jdx commented Apr 26, 2026

A small patch release that stops generated release notes from saying the same thing three times, and keeps communique's own sponsor footer from compounding on workflow reruns.

Fixed

  • Reserve Highlights for genuinely broad releases — The release-note system prompt and the submit_release_notes tool schema have been retightened so the model stops producing a ## Highlights section that just restates the categorized ## Added / ## Fixed bullets underneath it. The opening summary is now capped at 1-2 sentences, Highlights are gated on "roughly 10+ distinct user-facing changes or 4+ independent headline themes", and the prompt explicitly assigns each section a distinct job: the opening paragraph frames the release, Highlights (when present) group broad themes for skimming, and categorized sections carry the concrete PR links, authors, examples, and compatibility notes. The prompt also tells the model directly to avoid saying the same change three times. Patch and small minor releases should now skip Highlights entirely instead of padding them out. (#124) (@jdx)
  • Dedupe the sponsor blurb on release reruns — communique's own release-plz workflow appends a ## 💚 Sponsor communique footer to each GitHub release. If the workflow re-ran, or if communique itself drafted notes that already included a sponsor section, the footer would stack up. The Append en.dev sponsor blurb step is now idempotent: it strips any existing ## 💚 Sponsor communique section from the current release body before appending the canonical en.dev blurb. (#123) (@jdx)

Note

Low Risk
Low risk: this PR only bumps version metadata and updates generated documentation/changelog; no runtime behavior changes are included in the diff (aside from a potential CHANGELOG.md formatting glitch).

Overview
Cuts the v1.1.1 release by bumping the crate/CLI version from 1.1.01.1.1 across Cargo.toml, Cargo.lock, the usage spec, and generated CLI docs.

Updates CHANGELOG.md with a new 1.1.1 entry describing two fixes, though the edit also leaves a formatting issue where the 1.1.0 entry appears to run into the 1.0.4 header.

Reviewed by Cursor Bugbot for commit 82507c2. Bugbot is set up for automated code reviews on this repo. Configure here.

@jdx jdx changed the title chore: release v1.1.1 v1.1.1: Less repetitive release notes Apr 26, 2026
@jdx jdx force-pushed the release-plz-2026-04-26T13-38-17Z branch from a40ad5a to 82507c2 Compare April 26, 2026 13:39
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request increments the version of communique to 1.1.1 in the manifest files and updates the changelog with details on recent fixes. A review comment points out that the new changelog entry is placed out of chronological order, suggesting it should be moved to the top of the file to follow best practices.

Comment thread CHANGELOG.md

- Reduce repetitive Highlights in generated release notes by tightening the system prompt and tool schema ([#124](https://github.com/jdx/communique/pull/124))
- Dedupe the sponsor blurb in communique's own GitHub releases when the workflow re-runs ([#123](https://github.com/jdx/communique/pull/123))

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The changelog entries are out of chronological order. Version 1.1.1 is being placed below version 1.1.0. According to Keep a Changelog best practices, newer versions should be placed at the top of the file, immediately below the ## [Unreleased] section.

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 26, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.66%. Comparing base (89934a9) to head (82507c2).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #125   +/-   ##
=======================================
  Coverage   94.66%   94.66%           
=======================================
  Files          26       26           
  Lines        4708     4708           
  Branches     4708     4708           
=======================================
  Hits         4457     4457           
  Misses        160      160           
  Partials       91       91           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented Apr 26, 2026

Greptile Summary

This is a patch release (v1.1.1) that bumps the version across all artifacts (Cargo.toml, Cargo.lock, communique.usage.kdl, docs/cli/commands.json, docs/cli/index.md) and records two bug fixes in CHANGELOG.md: tightening the release-note system prompt to avoid repetitive Highlights sections, and making the sponsor-blurb append step idempotent on workflow reruns.

  • The blank line between the 1.1.0 Added bullet and the ## [1.0.4] heading was accidentally removed, concatenating the heading onto the bullet text. This breaks markdown rendering of the 1.0.4 section — the heading is no longer parsed as a heading in the rendered changelog.

Confidence Score: 3/5

Safe to merge after fixing the missing newline in CHANGELOG.md that breaks the 1.0.4 section heading.

One P1 finding: the 1.0.4 version heading is collapsed onto the preceding bullet, making that changelog section invisible in rendered output. All other changes are clean version-string bumps with no logic involved.

CHANGELOG.md — line 21, missing newline before the ## [1.0.4] heading.

Important Files Changed

Filename Overview
CHANGELOG.md Adds 1.1.1 release section, but removes the blank line separating the 1.1.0 Added bullet from the ## [1.0.4] heading, breaking markdown rendering of that section.
Cargo.toml Version bumped from 1.1.0 to 1.1.1 — straightforward patch version increment.
Cargo.lock Lock file updated to reflect the communique package version bump to 1.1.1.
communique.usage.kdl Version string updated to 1.1.1 to keep usage metadata in sync.
docs/cli/commands.json CLI docs version field bumped to 1.1.1.
docs/cli/index.md CLI docs version string bumped to 1.1.1.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A["release-plz workflow triggered"] --> B["Generate release notes\n(tightened system prompt — no redundant Highlights)"]
    B --> C["Append sponsor blurb step"]
    C --> D{"Existing sponsor section\nin release body?"}
    D -- Yes --> E["Strip existing ## 💚 Sponsor communique section"]
    E --> F["Append canonical en.dev blurb"]
    D -- No --> F
    F --> G["Publish GitHub Release v1.1.1"]
Loading

Fix All in Claude Code

Reviews (1): Last reviewed commit: "chore: release v1.1.1" | Re-trigger Greptile

Comment thread CHANGELOG.md
- *(generate)* Support `communique generate HEAD --changelog` as an intentional `[Unreleased]` target — replaces the existing `## [Unreleased]` section in place instead of inserting a literal `## [HEAD]` entry, with prompt/title labels switched to "unreleased" wording and an early guard rejecting `HEAD --github-release`. ([#121](https://github.com/jdx/communique/pull/121)) (@ThomasK33)

## [1.0.4](https://github.com/jdx/communique/releases/tag/v1.0.4) - 2026-04-24
- *(generate)* Support `communique generate HEAD --changelog` as an intentional `[Unreleased]` target — replaces the existing `## [Unreleased]` section in place instead of inserting a literal `## [HEAD]` entry, with prompt/title labels switched to "unreleased" wording and an early guard rejecting `HEAD --github-release`. ([#121](https://github.com/jdx/communique/pull/121)) (@ThomasK33)## [1.0.4](https://github.com/jdx/communique/releases/tag/v1.0.4) - 2026-04-24
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Missing newline corrupts the 1.0.4 section header

The blank line between the 1.1.0 "Added" bullet and the ## [1.0.4] heading was removed by this PR, so the heading is now concatenated onto the tail of the bullet text. Markdown will not parse ## [1.0.4] as a heading when it is glued to the previous line — it just becomes trailing prose on the list item, making the 1.0.4 section invisible in rendered output.

Suggested change
- *(generate)* Support `communique generate HEAD --changelog` as an intentional `[Unreleased]` target — replaces the existing `## [Unreleased]` section in place instead of inserting a literal `## [HEAD]` entry, with prompt/title labels switched to "unreleased" wording and an early guard rejecting `HEAD --github-release`. ([#121](https://github.com/jdx/communique/pull/121)) (@ThomasK33)## [1.0.4](https://github.com/jdx/communique/releases/tag/v1.0.4) - 2026-04-24
- *(generate)* Support `communique generate HEAD --changelog` as an intentional `[Unreleased]` target — replaces the existing `## [Unreleased]` section in place instead of inserting a literal `## [HEAD]` entry, with prompt/title labels switched to "unreleased" wording and an early guard rejecting `HEAD --github-release`. ([#121](https://github.com/jdx/communique/pull/121)) (`@ThomasK33`)
## [1.0.4](https://github.com/jdx/communique/releases/tag/v1.0.4) - 2026-04-24

Fix in Claude Code

Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 82507c2. Configure here.

Comment thread CHANGELOG.md
- *(generate)* Support `communique generate HEAD --changelog` as an intentional `[Unreleased]` target — replaces the existing `## [Unreleased]` section in place instead of inserting a literal `## [HEAD]` entry, with prompt/title labels switched to "unreleased" wording and an early guard rejecting `HEAD --github-release`. ([#121](https://github.com/jdx/communique/pull/121)) (@ThomasK33)

## [1.0.4](https://github.com/jdx/communique/releases/tag/v1.0.4) - 2026-04-24
- *(generate)* Support `communique generate HEAD --changelog` as an intentional `[Unreleased]` target — replaces the existing `## [Unreleased]` section in place instead of inserting a literal `## [HEAD]` entry, with prompt/title labels switched to "unreleased" wording and an early guard rejecting `HEAD --github-release`. ([#121](https://github.com/jdx/communique/pull/121)) (@ThomasK33)## [1.0.4](https://github.com/jdx/communique/releases/tag/v1.0.4) - 2026-04-24
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing newline merges section heading into bullet point

Medium Severity

The ## [1.0.4] section heading got concatenated directly onto the end of the preceding bullet point text (after (@ThomasK33)), with no newline separating them. This means ## [1.0.4] and everything beneath it will render as part of the bullet point text rather than as a proper Markdown heading, breaking the changelog's structure for all entries from v1.0.4 downward.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 82507c2. Configure here.

@jdx jdx merged commit 895878d into main Apr 26, 2026
9 checks passed
@jdx jdx deleted the release-plz-2026-04-26T13-38-17Z branch April 26, 2026 13:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant