后端數(shù)據(jù)庫負(fù)載均衡【免費(fèi)下載鏈接】proxysqlHigh-performance proxy for MySQL and PostgreSQL項(xiàng)目地址https://gitcode.com/gh_mirrors/pr/proxysql點(diǎn)擊查看免費(fèi)下載本文檔是 ProxySQL 倉庫中發(fā)布說明生成工作流的核心提示詞模板 —— enhanced_prompt_template.md —— 的完整技術(shù)解讀與實(shí)戰(zhàn)指南。它面向數(shù)據(jù)庫管理員、開發(fā)者和開源貢獻(xiàn)者講解如何基于pr-data.json、structured-notes.md、commit-categories.md三類數(shù)據(jù)文件借助 LLM 生成解釋每個(gè)特性/修復(fù)做什么、為什么重要的描述性發(fā)布說明而不是簡單羅列 PR 標(biāo)題。讀完本文你將掌握增強(qiáng)版發(fā)布說明的結(jié)構(gòu)規(guī)范、寫作風(fēng)格、技術(shù)術(shù)語反引號(hào)backtick格式化規(guī)則以及如何將其接入 scripts/release-tools 中現(xiàn)成的編排腳本產(chǎn)出與 ProxySQL-3.0.4-Release-Notes-Enhanced.md 同等質(zhì)量的發(fā)布文檔。背景為什么需要增強(qiáng)版發(fā)布說明ProxySQL 是一個(gè)同時(shí)代理 MySQL 與 PostgreSQL 的高性能數(shù)據(jù)庫中間件每個(gè)版本都會(huì)合入大量 PR 與提交。傳統(tǒng)發(fā)布說明如果只是把 PR 標(biāo)題拼成列表讀者無法快速判斷某個(gè)變更是否影響自己的部署環(huán)境、是否值得升級(jí)。因此倉庫的scripts/release-tools目錄維護(hù)了一套提示詞模板 數(shù)據(jù)采集腳本 示例產(chǎn)物的完整方案數(shù)據(jù)采集與整理由 collect_pr_data.py、generate_structured_notes.py、categorize_commits.py 完成一鍵編排入口是 orchestrate_release.py它會(huì)依次產(chǎn)出 PR 數(shù)據(jù)、結(jié)構(gòu)化筆記、提交分類并自動(dòng)生成一份傳給 LLM 的提示詞最終的人工可讀敘述質(zhì)量則取決于這份 enhanced_prompt_template.md 提示詞模板 —— 它是整個(gè)工作流中決定生成結(jié)果好不好看的關(guān)鍵一環(huán)。模板的輸入三類數(shù)據(jù)文件提示詞模板要求基于以下三個(gè)數(shù)據(jù)文件生成發(fā)布說明數(shù)據(jù)文件內(nèi)容來源腳本pr-data.json來自 GitHub 的全部 PR 詳情包括標(biāo)題、描述、標(biāo)簽、提交列表、合并哈希collect_pr_data.pystructured-notes.md按提交粒度整理的技術(shù)數(shù)據(jù)generate_structured_notes.pycommit-categories.md按類型bug fix、feature、documentation 等分類的提交清單categorize_commits.py其中pr-data.json通過gh pr view拉取 PR 的title,body,number,url,labels,state,createdAt,mergedAt,author等字段并附加commits數(shù)組與merge_hashstructured-notes.md在此基礎(chǔ)上按關(guān)鍵詞啟發(fā)式歸類Documentation、Testing、Build/Packaging、Bug Fixes、PostgreSQL、MySQL、Monitoring、Performance、Other并抽取每個(gè) PR 內(nèi)提交的短哈希與 headlinecommit-categories.md則對(duì)提交消息做詞頻打分把fix/bug/crash/vulnerability歸入 Bug Fix把a(bǔ)dd/support/implement歸入 New Feature把improve/optimize/performance歸入 Improvement依此類推。總體結(jié)構(gòu)要求Overall Structure模板對(duì)發(fā)布說明的整體骨架給出明確約束必須逐條滿足以一段簡潔的開篇引言開始概括本版本的意義包含一個(gè)Highlights 小節(jié)用要點(diǎn)bullet points概括關(guān)鍵改進(jìn)領(lǐng)域?qū)⒆兏M織在邏輯分類之下New Features、Bug Fixes、Improvements、Documentation、Testing、Build/Packaging、Other Changes每個(gè)主要章節(jié)配一句簡短的主題引言交代該章的敘述主線結(jié)尾以反引號(hào)包裹發(fā)布提交哈希收束全文。以倉庫中的示例 ProxySQL-3.0.4-Release-Notes-Enhanced.md 為參照其開篇即點(diǎn)明本次發(fā)布顯著增強(qiáng)了 PostgreSQL 兼容性、MySQL 協(xié)議健壯性、監(jiān)控準(zhǔn)確性與安全加固結(jié)尾以faa64a570d19fe35af43494db0babdee3e3cdc89標(biāo)注發(fā)布提交并在末尾 Hashes 小節(jié)再次強(qiáng)調(diào)該哈希。注意generate_release_notes.py這類腳本生成的基礎(chǔ)版說明只輸出Release range: vX 到 vY而增強(qiáng)版模板要求的是具體發(fā)布提交哈希這是兩者最直觀的區(qū)別。寫作風(fēng)格要求Writing Style模板明確規(guī)定LLM 產(chǎn)出的不是 PR 標(biāo)題清單而是描述性段落每個(gè)特性/修復(fù)至少寫24 句描述性段落解釋變更做了什么what以及為什么對(duì)用戶/管理員重要why使用語法完整的句子保持行文流暢避免不作解釋的術(shù)語堆砌 —— 假設(shè)部分讀者并非資深技術(shù)專家整體語氣專業(yè)但平易近人professional yet accessible。換句話說評(píng)判發(fā)布說明質(zhì)量的核心標(biāo)準(zhǔn)是讀者看完一段話能否理解這個(gè)變更解決什么問題、對(duì)自己的環(huán)境有什么價(jià)值而非是否忠實(shí)轉(zhuǎn)述了 commit message。技術(shù)格式要求Technical Formatting這是增強(qiáng)版模板最具操作性的部分它要求把所有技術(shù)術(shù)語用反引號(hào)包裹并給出了覆蓋不同類別的示例類別示例函數(shù)名Read_Global_Variables_from_configfile()變量名wait_timeout、cur_cmd_cmntSQL 查詢SELECT version、SELECT VERSION()協(xié)議命令COM_PING、CLIENT_DEPRECATE_EOF配置項(xiàng)cache_empty_result0指標(biāo)PgSQL_Monitor_ssl_connections_OK其他文件路徑、命令名、代碼片段同時(shí)必須遵守以下紀(jì)律每項(xiàng)變更后用括號(hào)附上短格式提交哈希與PR 編號(hào)如(285fb1b4, #5254)最終輸出中移除任何[WIP]、[skip-ci]等標(biāo)簽用加粗標(biāo)注特性/修復(fù)名稱后跟提交/PR 引用。需要特別說明的是這些反引號(hào)格式化不能由腳本自動(dòng)完成。倉庫 README.md 明確寫道腳本不會(huì)自動(dòng)加反引號(hào)生成最終發(fā)布說明時(shí)需由 LLM 依靠對(duì)代碼庫的理解自行判斷哪些術(shù)語需要格式化再人工復(fù)核一致性。例如 ProxySQL-3.0.4-Release-Notes-Enhanced.md 中SELECT version、cache_empty_result0、mysql_affected_rows()、PgSQL_Monitor_ssl_connections_OK等術(shù)語全部被正確包裹這種一致性正是發(fā)布說明專業(yè)性的體現(xiàn)。各章節(jié)編寫細(xì)則Section GuidelinesHighlights 小節(jié)用46 個(gè)要點(diǎn)總結(jié)最顯著的改進(jìn)聚焦用戶/管理員收益而不是內(nèi)部實(shí)現(xiàn)細(xì)節(jié)模板給出的示例句式Enhanced PostgreSQL support with SSL/TLS backend connections。對(duì)照 3.0.4 示例其 Highlights 用五條要點(diǎn)分別概括 PostgreSQL 支持增強(qiáng)PG 專用 tokenizer 后端 SSL/TLS、MySQL 協(xié)議健壯性異常COM_PING處理、SELECT version直接應(yīng)答、監(jiān)控改進(jìn)Ping 延遲修復(fù)、TCP keepalive 告警、安全加固配置解析 SQL 注入修復(fù)與性能優(yōu)化prepared statement 緩存無鎖熱路徑。New Features 小節(jié)將相關(guān)特性歸入子類別例如PostgreSQL Improvements、MySQL Protocol Enhancements、Monitoring Diagnostics每個(gè)子類別以一句簡短引言開頭每個(gè)特性的條目格式為加粗標(biāo)題提交哈希PR 編號(hào) 描述性段落。Bug Fixes 小節(jié)以固定的引入句開頭模板給出的是This release addresses several critical issues affecting...按受影響組件分組MySQL、Monitoring、Security Configuration 等每個(gè)修復(fù)條目先清楚說明問題再解釋解決方案。3.0.4 示例中的cur_cmd_cmnt線程安全修復(fù)就嚴(yán)格遵循這一結(jié)構(gòu)先說該變量跨線程共享、多線程環(huán)境下存在競(jìng)態(tài)條件再說本修復(fù)確保線程安全訪問防止多線程并發(fā)處理查詢時(shí)出現(xiàn)不一致行為。Improvements 小節(jié)聚焦性能、穩(wěn)定性與效率提升解釋影響面例如減少鎖競(jìng)爭reduced contention、提升兼容性improved compatibility等。其余章節(jié)Documentation、Testing、Build/Packaging每個(gè)章節(jié)都要有簡短的引言句解釋實(shí)用價(jià)值例如更好的可維護(hù)性better maintainability、更廣的平臺(tái)支持expanded platform support。每條條目的統(tǒng)一格式模板模板給出了一個(gè)可復(fù)制的條目模板后續(xù) LLM 生成時(shí)逐條套用**Feature Name** (abc1234, #1234) Descriptive paragraph explaining what this feature does and why it matters. Include technical details like technical terms in backticks. Explain benefits to users/administrators.輸出文件與質(zhì)量自檢清單輸出文件LLM 需要生成以下文件ProxySQL-X.X.X-Release-Notes-Enhanced.md—— 主增強(qiáng)版發(fā)布說明必選CHANGELOG-X.X.X-detailed.md—— 詳細(xì) changelog可選CHANGELOG-X.X.X-commits.md—— 完整提交清單可選。倉庫中 CHANGELOG-3.0.4-detailed.md 與 CHANGELOG-3.0.4-commits.md 即為 3.0.4 的對(duì)應(yīng)示例產(chǎn)物。質(zhì)量自檢清單Quality Checklist模板末尾附帶一份可勾選的清單用于交付前驗(yàn)證每個(gè)特性/修復(fù)都有描述性段落而不只是標(biāo)題所有技術(shù)術(shù)語都正確包裹在反引號(hào)內(nèi)包含提交哈希與 PR 編號(hào)各章節(jié)引言提供了上下文Highlights 小節(jié)給出快速概覽不再殘留[WIP]/[skip-ci]標(biāo)簽全文格式一致相關(guān)變更被邏輯分組。目標(biāo)讀者與語氣Tone Audience模板明確發(fā)布說明的四大讀者群體數(shù)據(jù)庫管理員Database administrators——需要理解新特性與修復(fù)的影響面集成 ProxySQL 的開發(fā)者Developers——關(guān)心 API/協(xié)議行為變化評(píng)估 ProxySQL 的系統(tǒng)架構(gòu)師System architects——需要據(jù)此做技術(shù)決策開源貢獻(xiàn)者Open source contributors——借此了解項(xiàng)目演進(jìn)方向。因此發(fā)布說明的信息密度要足以支撐技術(shù)決策同時(shí)保持對(duì)只具備通用數(shù)據(jù)庫/代理知識(shí)的讀者友好。把模板接入實(shí)際工作流提示詞模板不是孤立文檔它對(duì)應(yīng)scripts/release-tools中一條完整的發(fā)布流程。推薦路徑是直接使用編排腳本python orchestrate_release.py --from-tag v3.0.3 --to-tag v3.0.4 --output-dir release-data --verbose該腳本依次執(zhí)行collect_pr_data.py采集 PR 詳情 →generate_structured_notes.py生成結(jié)構(gòu)化筆記 →categorize_commits.py分類提交 → 自動(dòng)生成llm-prompt-X.X.X.md與workflow-summary.md。從源碼看orchestrate_release.py它生成的提示詞會(huì)內(nèi)嵌數(shù)據(jù)文件清單、任務(wù)要求、示例結(jié)構(gòu)與數(shù)據(jù)預(yù)覽而 enhanced_prompt_template.md 正是這份自動(dòng)生成提示詞在敘述質(zhì)量層面的規(guī)范藍(lán)本。也可以完全手動(dòng)執(zhí)行四個(gè)步驟# 1. 準(zhǔn)備環(huán)境確保分支正確、標(biāo)簽齊全 git fetch --tags git checkout v3.0 # 2. 采集 PR 數(shù)據(jù) python collect_pr_data.py --from-tag v3.0.3 --to-tag v3.0.4 --output pr-data.json --verbose # 3. 生成結(jié)構(gòu)化分析文件 python generate_structured_notes.py --input pr-data.json --output structured-notes.md --verbose python categorize_commits.py --from-tag v3.0.3 --to-tag v3.0.4 --output-format markdown commit-categories.md # 4. 將上述三個(gè)數(shù)據(jù)文件連同本模板一起提供給 LLM分類映射的微調(diào)generate_release_notes.py支持通過 JSON 配置文件手工覆蓋自動(dòng)分類格式見 category_mapping.example.json{ 5259: [Bug Fixes, MySQL], 5257: [New Features, MySQL], 5258: Documentation }每個(gè)鍵是 PR 編號(hào)值可以是單個(gè)字符串分類名如Documentation或數(shù)組[分類, 子分類]如[New Features, PostgreSQL]。自動(dòng)分類按優(yōu)先級(jí)依次檢查手工映射、PR 標(biāo)簽bug/feature/documentation/test/security/refactor/improvement與標(biāo)題關(guān)鍵詞fix、add、improve、doc、test、build、monitor、postgresql、mysql 等未命中則歸入Other。實(shí)操中的注意事項(xiàng)GitHub CLI 認(rèn)證collect_pr_data.py與generate_release_notes.py依賴gh命令使用前確保已執(zhí)行g(shù)h auth login且對(duì)目標(biāo)倉庫有讀取權(quán)限參考 scripts/release-tools/README.md 的 Tips 章節(jié)標(biāo)簽名稱--from-tag/--to-tag必須使用精確的標(biāo)簽名如v3.0.3或分支名如HEAD人工復(fù)核自動(dòng)分類并非完美最終發(fā)布的說明必須人工審閱必要時(shí)通過配置文件修正分類模板定制可自由修改腳本中的分類關(guān)鍵詞以匹配項(xiàng)目約定但反引號(hào)格式化與描述性段落等敘述規(guī)范應(yīng)始終以 enhanced_prompt_template.md 為準(zhǔn)?？偨Y(jié)enhanced_prompt_template.md 本質(zhì)上是 ProxySQL 發(fā)布說明工作流中LLM 寫作規(guī)范的權(quán)威定義它把結(jié)構(gòu)、風(fēng)格、格式、章節(jié)細(xì)則、質(zhì)量清單全部顯式化配合 collect_pr_data.py、generate_structured_notes.py、categorize_commits.py 提供的數(shù)據(jù)底座以及 orchestrate_release.py 的一鍵編排即可在任意 ProxySQL 版本發(fā)布時(shí)穩(wěn)定復(fù)現(xiàn) ProxySQL-3.0.4-Release-Notes-Enhanced.md 級(jí)別的高質(zhì)量發(fā)布說明。對(duì)于維護(hù)者而言這套方案的價(jià)值在于把寫得好從個(gè)人經(jīng)驗(yàn)沉淀為可復(fù)用、可校驗(yàn)的工程規(guī)范。贊分享后端數(shù)據(jù)庫負(fù)載均衡【免費(fèi)下載鏈接】proxysqlHigh-performance proxy for MySQL and PostgreSQL項(xiàng)目地址https://gitcode.com/gh_mirrors/pr/proxysql點(diǎn)擊查看免費(fèi)下載相關(guān)推薦Elsa 精選發(fā)布說明Curated Release Notes編寫與發(fā)布實(shí)戰(zhàn)指南Elsa 精選發(fā)布說明Curated Release Notes編寫與發(fā)布實(shí)戰(zhàn)指南 本指南以 Elsa 倉庫的發(fā)布說明規(guī)范文檔 release notes后端工作流自動(dòng)化流程編排低代碼解鎖 WeMod 每日時(shí)長限制WandEnhancer 本地去 Pro 限制新手完整指南解鎖 WeMod 每日時(shí)長限制WandEnhancer 本地去 Pro 限制新手完整指南 如果你每天被 WeMod現(xiàn)更名 Wand的免費(fèi)時(shí)長倒計(jì)時(shí)提醒打擾桌面應(yīng)用前端Forge Release Notes 技能實(shí)戰(zhàn)基于 GitHub 數(shù)據(jù)自動(dòng)撰寫高質(zhì)量版本說明Forge Release Notes 技能實(shí)戰(zhàn)基于 GitHub 數(shù)據(jù)自動(dòng)撰寫高質(zhì)量版本說明 本文以 Forge 開源倉庫中的 write release人工智能AI Agent代碼智能體AI 應(yīng)用CLI開發(fā)工具上一篇prometeo開發(fā)者指南從源碼理解轉(zhuǎn)譯器、內(nèi)存分析與代碼生成三大核心模塊下一篇OpenResume離線存儲(chǔ)性能優(yōu)化從localStorage到IndexedDB的完整指南創(chuàng)作聲明：本文部分內(nèi)容由AI輔助生成（AIGC），僅供參考