You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: scripts/release-notes-ai-generator/release-notes-generator-readme.md
+20-4Lines changed: 20 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Release notes generator
2
2
3
-
`scripts/release_notes_generate_ai.py` generates English TiDB release notes for the `Improvements` and `Bug fixes` sections according to PRs and issues in a Excel workbook.
3
+
`python3 -m release_notes_ai` (run from the `scripts/` directory) generates English TiDB release notes for the `Improvements` and `Bug fixes` sections according to PRs and issues in a Excel workbook.
4
4
5
5
The generator keeps the source workbook unchanged, writes all processing results to a processed workbook, and renders the generated entries to a Markdown release note file.
6
6
@@ -33,7 +33,6 @@ The generator keeps the source workbook unchanged, writes all processing results
33
33
34
34
The generator does not create a complete formal release note. It does not generate sections such as compatibility changes, known issues, deprecations, or upgrade notes.
35
35
36
-
37
36
## Prerequisites
38
37
39
38
- Install Python dependencies:
@@ -50,15 +49,32 @@ The generator does not create a complete formal release note. It does not genera
50
49
51
50
- Install and log in to Codex CLI. The default `--ai-command` uses `codex exec`, so the installed Codex CLI must support `exec`, `--sandbox read-only`, `--ephemeral`, `--output-schema`, `--output-last-message`, and `-m <model>`. If you use `--ai-provider azure` instead, Codex CLI is not required;set`AZURE_OPENAI_KEY` and `AZURE_OPENAI_BASE_URL` (or `OPENAI_BASE_URL`) environment variables.
52
51
53
-
## Typical usage
52
+
## Typical usage examples
53
+
54
+
Use Codex to generate release notes:
54
55
55
56
```bash
56
-
python3 scripts/release_notes_generate_ai.py \
57
+
cd scripts
58
+
python3 -m release_notes_ai \
57
59
--version 8.5.7 \
58
60
--excel /path/to/release-note-excel.xlsx \
59
61
--releases-dir releases
60
62
```
61
63
64
+
Use Azure OpenAI to generate release notes:
65
+
66
+
```bash
67
+
export AZURE_OPENAI_KEY=<your-key>
68
+
export AZURE_OPENAI_BASE_URL=<your-endpoint>
69
+
export GITHUB_TOKEN=<your-token>
70
+
cd scripts
71
+
python3 -m release_notes_ai \
72
+
--version 8.5.7 \
73
+
--excel /path/to/release-note-excel.xlsx \
74
+
--releases-dir releases \
75
+
--ai-provider azure
76
+
```
77
+
62
78
## Option descriptions
63
79
64
80
| Option | Required | Default value | Usage example | Description |
0 commit comments