Add categorized release notes tool by kelos-bot[bot] · Pull Request #521 · kelos-dev/kelos

kelos-bot · 2026-03-02T12:43:19Z

Which issue(s) this PR is related to:

Fixes #519

Description

Add a Go program for generating categorized release notes from merged PR descriptions, replacing the default auto-generated flat notes.

Changes:

Add a minimal PR template (.github/PULL_REQUEST_TEMPLATE.md) with a "Which issue(s)" prompt and a release-note fenced block
Add hack/release-notes/ Go program that collects merged PRs between two release tags (using bounded date range), extracts release note blocks, and groups entries by kind/* labels into categories: API Changes, Features, Bug Fixes, Documentation, and Other Changes
Add unit tests for note extraction, NONE detection, and formatting logic (covered by make test)
Update .github/workflows/release.yaml to use fetch-depth: 0 and run the release notes program via go run

Release Note

Added categorized release notes generated from PR descriptions, grouped by kind/* labels

cubic-dev-ai

4 issues found across 4 files

Prompt for AI agents (unresolved issues)


Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name=".github/workflows/release.yaml">

<violation number="1" location=".github/workflows/release.yaml:64">
P0: The `release-notes.sh` script requires full git history (it runs `git tag --list` and `git merge-base`), but the workflow's `actions/checkout@v4` step uses the default shallow clone (`fetch-depth: 1`). This will cause the step to fail on every tag push because tags and history are not available.

Add `fetch-depth: 0` to the checkout step, or add a separate step before this one to fetch tags and history (e.g., `git fetch --prune --unshallow --tags`).</violation>
</file>

<file name="hack/release-notes.sh">

<violation number="1" location="hack/release-notes.sh:41">
P2: Missing upper-bound on the merged-date search query. PRs merged after the `VERSION` tag was created will be incorrectly included in these release notes. Add a `merged:<=<version-tag-date>` filter to scope the query to the correct release window.</violation>

<violation number="2" location="hack/release-notes.sh:79">
P2: Using `echo` with untrusted PR content is fragile — if `note` is `-n`, `-e`, or `-E`, bash's `echo` interprets it as a flag and produces incorrect output. Prefer `printf '%s\n'` or a here-string (`<<<`).</violation>
</file>

<file name="hack/release-notes_test.sh">

<violation number="1" location="hack/release-notes_test.sh:28">
P2: Test duplicates the extraction logic from `hack/release-notes.sh` instead of sourcing it. If the production `sed` expression changes, these tests will still pass against the stale copy, masking regressions. Consider refactoring the extraction into a small sourced helper (e.g., `hack/release-notes-lib.sh`) that both the main script and the test import, or have the test invoke the production script's extraction path directly.</violation>
</file>

_{Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.}

.github/workflows/release.yaml

hack/release-notes.sh

hack/release-notes_test.sh

gjkim42

How can we make agents follow the pull_request template?

gjkim42 · 2026-03-02T12:45:56Z

.github/PULL_REQUEST_TEMPLATE.md

+-->
+
+```release-note
+NONE


this should be empty so that users can write their own.

.github/PULL_REQUEST_TEMPLATE.md

gjkim42 · 2026-03-02T12:48:34Z

/reset-worker

gjkim42

lgtm
/squash-commits

gjkim42

/reset-worker

gjkim42 · 2026-03-02T13:25:43Z

hack/release-notes_test.sh

@@ -0,0 +1,99 @@
+#!/usr/bin/env bash


this should be tested in CI.

cubic-dev-ai

1 issue found across 2 files (changes from recent commits).

Prompt for AI agents (unresolved issues)


Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name=".github/workflows/ci.yaml">

<violation number="1" location=".github/workflows/ci.yaml:65">
P2: This is the only CI step that directly invokes a script instead of using a Makefile target, breaking the project's established convention. Consider adding a Makefile target (e.g., `test-release-notes`) and using `make test-release-notes` here to stay consistent with the rest of the workflow.</violation>
</file>

_{Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.}

.github/workflows/ci.yaml

gjkim42

/reset-worker

gjkim42 · 2026-03-02T14:42:07Z

hack/release-notes.sh

@@ -0,0 +1,132 @@
+#!/usr/bin/env bash


Let's make a golang program for this

cubic-dev-ai

1 issue found across 7 files (changes from recent commits).

Prompt for AI agents (unresolved issues)


Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="hack/release-notes/main.go">

<violation number="1" location="hack/release-notes/main.go:148">
P1: Bug: `findPreviousTag` returns the wrong tag when `version` is not the latest release. The function returns the first tag that isn't `version` in descending order, which is always the latest tag — not the one immediately before `version`. For example, generating notes for `v1.2.1` when `v1.3.0` exists would compare against `v1.3.0` instead of `v1.2.0`. Fix: iterate until you find `version`, then return the next tag.</violation>
</file>

_{Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.}

cubic-dev-ai · 2026-03-02T15:08:06Z

hack/release-notes/main.go

+	if err != nil {
+		return "", fmt.Errorf("listing tags: %w", err)
+	}
+	for _, tag := range strings.Split(strings.TrimSpace(out), "\n") {


P1: Bug: findPreviousTag returns the wrong tag when version is not the latest release. The function returns the first tag that isn't version in descending order, which is always the latest tag — not the one immediately before version. For example, generating notes for v1.2.1 when v1.3.0 exists would compare against v1.3.0 instead of v1.2.0. Fix: iterate until you find version, then return the next tag.

Prompt for AI agents

Check if this issue is valid — if so, understand the root cause and fix it. At hack/release-notes/main.go, line 148: <comment>Bug: `findPreviousTag` returns the wrong tag when `version` is not the latest release. The function returns the first tag that isn't `version` in descending order, which is always the latest tag — not the one immediately before `version`. For example, generating notes for `v1.2.1` when `v1.3.0` exists would compare against `v1.3.0` instead of `v1.2.0`. Fix: iterate until you find `version`, then return the next tag.</comment> <file context> @@ -0,0 +1,265 @@ + if err != nil { + return "", fmt.Errorf("listing tags: %w", err) + } + for _, tag := range strings.Split(strings.TrimSpace(out), "\n") { + tag = strings.TrimSpace(tag) + if tag != "" && tag != version { </file context>

gjkim42

Fix findPreviousTag ans squash commits.
/reset-worker

- Add a minimal PR template (.github/PULL_REQUEST_TEMPLATE.md) with a "Which issue(s)" prompt and a release-note fenced block - Add hack/release-notes/ Go program that collects merged PRs between two release tags (using bounded date range), extracts release note blocks, and groups entries by kind/* labels into categories: API Changes, Features, Bug Fixes, Documentation, and Other Changes - Add unit tests for note extraction, NONE detection, and formatting logic - Update .github/workflows/release.yaml to use fetch-depth: 0 and run the release notes program via go run Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

kelos-bot bot added generated-by-kelos ok-to-test labels Mar 2, 2026

github-actions bot added needs-triage needs-kind Indicates an issue or PR lacks a kind/* label needs-priority needs-actor labels Mar 2, 2026

cubic-dev-ai bot reviewed Mar 2, 2026

View reviewed changes

.github/workflows/release.yaml Outdated Show resolved Hide resolved

hack/release-notes.sh Outdated Show resolved Hide resolved

hack/release-notes.sh Outdated Show resolved Hide resolved

hack/release-notes_test.sh Outdated Show resolved Hide resolved

gjkim42 requested changes Mar 2, 2026

View reviewed changes

gjkim42 added priority/important-longterm triage-accepted kind/feature Categorizes issue or PR as related to a new feature labels Mar 2, 2026

github-actions bot removed needs-triage needs-kind Indicates an issue or PR lacks a kind/* label needs-priority labels Mar 2, 2026

gjkim42 approved these changes Mar 2, 2026

View reviewed changes

kelos-bot bot force-pushed the kelos-task-519 branch from 83034d9 to 0a66c7d Compare March 2, 2026 13:21

gjkim42 enabled auto-merge March 2, 2026 13:25

gjkim42 disabled auto-merge March 2, 2026 13:25

gjkim42 requested changes Mar 2, 2026

View reviewed changes

hack/release-notes_test.sh Outdated

@@ -0,0 +1,99 @@

#!/usr/bin/env bash

Copy link

Collaborator

gjkim42 Mar 2, 2026

Choose a reason for hiding this comment

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

this should be tested in CI.

kelos-bot bot mentioned this pull request Mar 2, 2026

Add categorized release notes from PR descriptions #519

Closed

cubic-dev-ai bot reviewed Mar 2, 2026

View reviewed changes

.github/workflows/ci.yaml Outdated Show resolved Hide resolved

gjkim42 requested changes Mar 2, 2026

View reviewed changes

hack/release-notes.sh Outdated

@@ -0,0 +1,132 @@

#!/usr/bin/env bash

Copy link

Collaborator

gjkim42 Mar 2, 2026

Choose a reason for hiding this comment

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

Let's make a golang program for this

cubic-dev-ai bot reviewed Mar 2, 2026

View reviewed changes

gjkim42 requested changes Mar 2, 2026

View reviewed changes

kelos-bot bot force-pushed the kelos-task-519 branch from 7a2e0ec to 59ad039 Compare March 2, 2026 15:47

kelos-bot bot changed the title ~~Add categorized release notes from PR descriptions~~ Add categorized release notes tool Mar 2, 2026

gjkim42 approved these changes Mar 3, 2026

View reviewed changes

gjkim42 added this pull request to the merge queue Mar 3, 2026

Merged via the queue into main with commit df8751b Mar 3, 2026
8 checks passed

gjkim42 deleted the kelos-task-519 branch March 3, 2026 00:43

This was referenced Mar 4, 2026

Prompt Tuning: kelos-workers prompt missing PR template compliance (kind labels, release-note blocks) #538

Closed

Workflow: Add complexity-aware delivery strategy to kelos-workers prompt #542

Closed

Conversation

kelos-bot bot commented Mar 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Release Note

Uh oh!

cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gjkim42 left a comment

Choose a reason for hiding this comment

Uh oh!

gjkim42 Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

gjkim42 commented Mar 2, 2026

Uh oh!

gjkim42 left a comment

Choose a reason for hiding this comment

Uh oh!

gjkim42 left a comment

Choose a reason for hiding this comment

Uh oh!

gjkim42 Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

gjkim42 left a comment

Choose a reason for hiding this comment

Uh oh!

gjkim42 Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

cubic-dev-ai bot Mar 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gjkim42 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

kelos-bot bot commented Mar 2, 2026 •

edited

Loading

cubic-dev-ai bot Mar 2, 2026 •

edited

Loading