Skip to content

Commit b4ea7ce

Browse files
committed
explain formatted_release_note_from_excel
1 parent e3977f3 commit b4ea7ce

3 files changed

Lines changed: 8 additions & 2 deletions

File tree

scripts/release-notes-generator-readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ This separation is intentional. If the same issue appears again in the same majo
182182
For target version `8.5.7`, the same-series quarantine sheet is named:
183183
184184
```text
185-
issues_already_in_earlier_v8.5_notes
185+
issue_already_in_earlier_v8.5.x
186186
```
187187
188188
A row is moved to this sheet when all of the following are true:

scripts/release_notes_ai/excel_workbook.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -372,7 +372,7 @@ def same_series_release_files_by_issue_url(
372372

373373
def same_series_issues_sheet_name(version: str) -> str:
374374
major, minor, _patch = parse_semver_tuple(version)
375-
return f"issues_already_in_earlier_v{major}.{minor}_notes"
375+
return f"issue_already_in_earlier_v{major}.{minor}"
376376

377377

378378
def same_series_issue_reason(

scripts/release_notes_ai/prompts/generation.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,12 @@ Contributors:
3333
Row context:
3434
{{ROW_CONTEXT}}
3535

36+
About `formatted_release_note_from_excel`:
37+
38+
- This field can be empty, `None`, or a generic placeholder such as `Please refer to [Release Notes Language Style Guide](https://pingcap.github.io/tidb-dev-guide/contribute-to-tidb/release-notes-style-guide.html) to write a quality release note.`. In these cases, treat it as no usable release-note draft.
39+
- This field can also contain a draft release note written by the code PR author. In that case, use the draft as an important reference for the final release note, but verify and refine it against the PR code changes first and the issue description second.
40+
- Do not copy the draft blindly. Preserve its useful user-facing intent, correct unclear or inaccurate wording, and still follow all release-note style rules above.
41+
3642
Improvements reference:
3743
{{IMPROVEMENTS_REFERENCE}}
3844

0 commit comments

Comments
 (0)