mirror of
https://github.com/Molunerfinn/PicGo.git
synced 2026-10-19 16:14:41 +00:00
3.5 KiB
3.5 KiB
gen_changelog.md
This guide describes how to generate a consolidated changelog for any PicGo release series (e.g., 2.4.0, 2.5.0) from the GitHub release notes of its betas and finals
Source of truth
- Use GitHub release pages only (e.g.,
https://github.com/Molunerfinn/PicGo/releases/tag/vX.Y.Z-beta.NandvX.Y.Zif present). You can fetch these via MCP GitHub APIs (e.g.,get_release_by_tag,list_releases) instead of manual browsing - Do not use
CHANGELOG.mdin the repo - Preserve all text and images exactly as written in the releases
- Exception: Remove holiday greetings (e.g., "Happy New Year!", "新年快乐!") from the generated changelog. These can stay in GitHub release notes but should not appear in
changelog/X.Y.Z.md
- Exception: Remove holiday greetings (e.g., "Happy New Year!", "新年快乐!") from the generated changelog. These can stay in GitHub release notes but should not appear in
Structure
- Target file:
changelog/X.Y.Z.md(replace with the series version) - Use these top-level sections when they contain items:
## Features,## Bug Fixes,## Other - Omit any empty section title entirely (do not output a heading with no bullets)
- Do not nest content under individual beta version headers; merge all items into these sections
- Keep items in chronological order (early → late) within each section, mirroring the beta sequence
- Keep inline issue references, thanks, and notes as-is
- Remove download-link sections entirely
- After the English sections, insert a line with
----------, then add a full Chinese translation with the same structure/content (including images)
Formatting rules
- Markdown, plain ASCII
- Bullet lists only; no numbered lists required
- Indent images under their bullet with two spaces to keep association clear
- Keep inline HTML image tags from the releases (e.g.,
<img width="...">) untouched - Keep line breaks and multi-line notes intact
- Do not reword or summarize; copy content verbatim except for removing beta headers and download sections
- If you need to add items from git commit logs (for the same release series), do not paste raw commit messages. Normalize them to the existing changelog style (e.g., use
Add:,Fix:,Refactor:prefixes without emoji) - Chinese translation must mirror the English bullets in order and content (keep images alongside the translated bullets)
Regeneration steps
- Collect all release bodies for the target series (e.g.,
vX.Y.Z-beta.0…Nand, if present,vX.Y.Z) from GitHub releases - For each release, copy bullets and images into the appropriate section:
- Features ↔ “Feature(s)” or “Features” blocks
- Bug Fixes ↔ “Bug Fixes” blocks
- Other ↔ “Other”, “Notice”, or misc notes that are not features/bugs
- If one section has no items after merging, skip that section heading in both EN and ZH halves
- Omit “国内可下载链接” (or any download links) entirely
- Drop beta subheadings; keep only section-level bullets in chronological order
- Ensure images remain adjacent to their bullets with indentation
- After the English sections are complete, insert
----------on its own line - Append the Chinese translation, preserving bullet order and images, reusing only the section headings that appeared in English (same heading set/order; no “(Chinese)” suffix)
- Save the result to
changelog/X.Y.Z.md
Quick checklist
- All non-empty Features items present with images kept
- All non-empty Bug Fixes items present
- All non-empty Other notes present
- No beta headers
- No download links
- No empty section headings
- Chronological ordering preserved
- Chinese translation present with matching bullets/images after
----------