Skip to content

release notes: include security dependency fixes in AI output #23727

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

Open
qiancai wants to merge 2 commits into
base: master
Choose a base branch
from
Open

release notes: include security dependency fixes in AI output #23727

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7b08bc7
release notes: classify security dependency fixes
qiancai Sep 3, 2026
8b1338b
Apply suggestions from code review
qiancai Sep 3, 2026
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
3 changes: 3 additions & 0 deletions scripts/release-notes-ai-generator/prompts/release-note.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Write a release note when the change is visible to TiDB users or operators, incl
- Meaningful performance improvements observable in common operations.
- Behavior changes that affect upgrade paths, tooling integration, or operational workflows.
- Default value changes for system variables or configuration parameters.
- Security fixes that address known or reported vulnerabilities affecting dependencies used by TiDB components shipped to users, even when only dependency manifests or lockfiles change and functional behavior remains unchanged.

Return a no-release-note verdict for internal-only changes, including:

Expand All @@ -30,6 +31,8 @@ Return a no-release-note verdict for internal-only changes, including:

If a PR is mostly internal but the outcome is user-visible, describe the outcome and omit implementation details. If the only user-facing effect is indirect or speculative, lean toward `not_needed`.

Do not classify a security dependency update as internal-only solely because it changes only dependency manifests or lockfiles. Return `not_needed` if the dependency is used only by tests, development or build tooling, or other unshipped code, or if the vulnerability does not affect the shipped component.

First, use all available context to decide whether the change needs a release note. If it does, classify it as follows:

- When `issue_type_from_excel` is non-empty, use it as the primary basis for choosing between `bug_fix` and `improvement`. Map values containing `bug` or `fix` to `bug_fix`, and values containing `improvement` or `enhancement` to `improvement`, case-insensitively. Use the issue, PR, changed-file summary, and Excel draft only as supporting context for understanding the user impact and writing an accurate entry. Do not override a type that maps clearly from `issue_type_from_excel` merely because the other context could support another classification.
Expand Down