Skip to content

Commit ac78b83

Browse files
committed
Enhance release notes generation script with improved prompt structure
- Updated the prompt in `generate_release_notes.py` to provide clearer guidelines for summarizing pull requests into well-formatted, concise bullet points. - Emphasized a friendly, developer-focused tone and included specific formatting instructions to enhance clarity and consistency in the generated release notes.
1 parent 5446487 commit ac78b83

File tree

1 file changed

+49
-7
lines changed

1 file changed

+49
-7
lines changed

scripts/generate_release_notes.py

Lines changed: 49 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,55 @@
99
# PR data passed from workflow
1010
pr_data = json.loads(sys.argv[1])
1111

12-
prompt = (
13-
"Summarize the following GitHub pull requests into clear, concise release notes bullets. "
14-
"Match the style and formatting of these example notes:\n\n"
15-
"- **[Guide Name](URL)** – Description of update\n"
16-
"- **Enhancement** – Brief description of the enhancement\n\n"
17-
"Pull requests to summarize:\n\n"
18-
)
12+
prompt = """
13+
You are an assistant writing public-facing release notes for BigCommerce’s Developer Center.
14+
15+
Your task is to summarize the following pull requests into **well-formatted, concise bullet points** that will appear in a published changelog.
16+
17+
* Use a **friendly, developer-focused tone**.
18+
* Write each bullet to clearly explain **what the change is and why it matters**.
19+
* Always include the **PR link** in the bullet point.
20+
* If the pull request includes a **"Release Notes" section** or release-focused summary, prioritize that, but cross-check the PR title and description to improve clarity and accuracy.
21+
* Group related bullet points under appropriate **bold section headings** such as:
22+
* **Admin GraphQL Updates**
23+
* **Webhooks Update**
24+
* **Enhancement**
25+
* **Bug Fixes**
26+
* **Developer Tooling**
27+
28+
Follow the formatting style shown below:
29+
30+
* **Section Name**
31+
32+
* **Short Bullet Title:** Brief description, including [relevant links](https://chatgpt.com/c/url) where applicable.
33+
34+
Important:
35+
36+
* Use present tense and **active voice** (e.g., "Adds", "Updates", "Introduces").
37+
* Keep each bullet point **under 2–3 sentences**.
38+
* Do not include internal or technical details irrelevant to external developers.
39+
* Do not invent content; if unsure, focus on what’s explicitly provided in the PR.
40+
41+
## **Here are some example bullets to mimic:**
42+
43+
**Admin GraphQL Updates**
44+
45+
* **New Guide: [Translations Admin GraphQL API (Beta)](https://developer.bigcommerce.com/docs/store-operations/translations)** – A new guide is now available to help merchants localize their Catalyst storefronts more efficiently. This API enables a consistent and seamless shopping experience across multiple languages.
46+
47+
* **Limitation** – Introduced a limit to the number of locales you can configure in the [Locales Configuration](https://developer.bigcommerce.com/docs/store-operations/settings/locales) settings.
48+
49+
**Webhooks Update**
50+
51+
* **Expanded Webhook Tools** – Added additional third-party webhook tools to the [Tools](https://developer.bigcommerce.com/docs/integrations/webhooks#tools) list for greater flexibility and integration support.
52+
53+
**Enhancement**
54+
55+
* **Channels API Update** – Updated the [Channels V3](https://developer.bigcommerce.com/docs/rest-management/channels#get-all-channels) schema to reflect the deprecation of the `is_enabled` field.
56+
57+
---
58+
59+
Pull requests to summarize:
60+
"""
1961

2062
for pr in pr_data:
2163
prompt += f"- Title: {pr['title']}\n Description: {pr['body']}\n Link: {pr['url']}\n\n"

0 commit comments

Comments
 (0)