Skip to content

docs: curate CHANGELOG — fill all release sections, fix accuracy, improve English, add PR links#648

Merged
gifnksm merged 6 commits into
mainfrom
copilot/update-changelog-with-missing-details
Apr 1, 2026
Merged

docs: curate CHANGELOG — fill all release sections, fix accuracy, improve English, add PR links#648
gifnksm merged 6 commits into
mainfrom
copilot/update-changelog-with-missing-details

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 1, 2026

Several release sections were empty or inaccurate. MSRV history was incomplete, a non-dependency change in [0.2.1] was missing, [0.2.0] was missing an entire Added section, the English phrasing was rough throughout, and no PR links were present for traceability.

All entries were verified against actual tag-to-tag diffs (not just commit messages) to ensure completeness.

Changes

  • [Unreleased] — filled with user-relevant changes since v0.2.2:

    • Added: souko list --template <FORMAT> — template-based output for picker integration (fzf/skim, etc.); unknown variable names are detected and reported as errors at startup (#643, #644)
    • Fixed: query.scheme_alias and query.custom_scheme can be omitted from config.toml without a parse error (#645)
    • Changed: MSRV bumped to 1.88.0 (was 1.78.0, via several intermediate steps); dependency updates summarized
    • Removed incorrect "Migrated to Rust edition 2024" (edition is still 2021)
  • [0.2.2] — MSRV bump to 1.78.0 (was 1.74.0) (#491) and dependency updates

  • [0.2.1] — added missing fix: output paths on Windows no longer include UNC prefix \\?\ (#462); added missing MSRV bump to 1.74.0 (was 1.70.0) (#463); dependency updates

  • [0.2.0] — added missing Added section for the vendored-libgit2 and vendored-openssl feature flags (#297); restructured breaking change description with clearer wording (#308)

  • [0.1.2] — added PR link for repository cache (#295)

  • [0.1.1] — improved phrasing of the config optionality fix; added PR link (#293)

  • English phrasing improved throughout all sections

  • PR links added to all substantive entries across all versions for traceability

Original prompt

Please update the CHANGELOG in repository gifnksm/souko and open a pull request.

Context and goals:

  • The maintainer forgot to update the CHANGELOG.
  • There are release sections in the CHANGELOG that currently have only headings (effectively empty) and should be filled.
  • For non-empty versions, add missing important items if any are missing.
  • Avoid very long verbose dependency bump lists; summarize dependency updates at a high level unless there is a user-impacting dependency change.
  • Keep entries focused on user-relevant changes (features, behavior changes, fixes, breaking changes, CLI/output/config changes, platform/packaging notes).

Required tasks:

  1. Inspect the existing CHANGELOG file and identify versions that are currently heading-only/empty.
  2. For each such version, gather release-relevant changes from merged PRs/commits for that release range and draft concise user-focused bullets.
  3. Review non-empty versions and add clearly missing user-relevant changes when appropriate.
  4. Reduce noise from dependency-only churn by replacing long dependency lists with concise summaries where suitable.
  5. Preserve the existing style/formatting of the repository’s CHANGELOG (version headings, comparison links, date format, section structure).
  6. Ensure factual correctness for release ranges and notable changes.
  7. Open a PR with a clear title and description summarizing what was curated and why.

Acceptance criteria:

  • No release section intended to be published remains effectively empty without explanation.
  • Changelog is noticeably more concise and user-oriented.
  • Dependency update noise is compressed into summaries unless a dependency change is user-impacting/breaking.
  • Existing markdown structure remains valid and consistent.
  • PR includes a short rationale about improving signal-to-noise for users.

The following is the prior conversation context from the user's chat exploration (may be truncated):

User: CHANGELOGの更新を忘れていた。更新できる?

Assistant: できます。
どの内容を CHANGELOG に追記するか(対象リリースや変更点)を教えてください。

必要ならこちらで進めます。例えば:

  • 対象リリース(例: v1.2.3
  • 追加する変更内容(箇条書きでOK)
  • 追記先ブランチ(指定なければ既定ブランチ)

内容をもらえれば、そのまま更新作業用のコミット内容まで作成します。

User: 空になってるリリース

Assistant: 確認しました。gifnksm/souko の公開済みリリース(v0.1.0〜v0.2.2)は、少なくとも GitHub Release の本文は空ではないです。

「空になってるリリース」は、たぶん CHANGELOG 側の該当バージョン見出しが空 という意味で合っていますか?

その前提なら、次にこれをやります:

  1. CHANGELOG ファイルを確認
  2. 空のリリース項目(例: ## [vX.Y.Z] の中身なし)を特定
  3. そのバージョンのPR/コミットから追記内容を作成して更新

進めてよければ、main に直接コミットしてよいか(または別ブランチ)だけ指定してください。

User: ファイルの方で見出しだけのやつのことですね。また、依存関係のアップデートを細かに書くと長くなりすぎるので、ユーザーにとって重要な情報を残したい。空ではないバージョンについても、漏れがあれば書きたい

Assistant: 了解です。方針は賛成です。
見出しだけのリリースを埋めつつ、依存関係アップデートは要約して、ユーザー影響のある変更を中心に整理しましょう。

このまま進めるために、1点だけ確認です:

  • main に直接反映でOKですか?
    (必要なら changelog-curation みたいなブランチに分けます)

OKなら、CHANGELOG を実際に走査して、

  • 空セクションの補完
  • 既存セクションの重要情報追記(漏れ補完)
  • 依存更新の圧縮(例:「内部依存関係を更新」へ集約)
    までまとめて更新します。

User: PR作って

Assistant: 了解、PR作成で進めます。
実行前に、反映方針だけ最終確認させてください。

  • 対象: gifnksm/souko
  • ベースブランチ: main でOK?
  • 変更方針:
    1. CHANGELOG の見出しだけのリリースを補完
    2. 空でないリリースもユーザー影響の観点で追記
    3. 依存関係更新は詳細列挙せず要約

この内容でそのままPRを作成します。

This pull request was created from Copilot chat.

Copilot AI changed the title [WIP] Update CHANGELOG with missing release details docs: curate CHANGELOG — fill empty release sections, compress dependency noise Apr 1, 2026
Copilot AI requested a review from gifnksm April 1, 2026 16:18
@gifnksm
Copy link
Copy Markdown
Owner

gifnksm commented Apr 1, 2026

@copilot 各タグ間の変更内容(diff & blame)も参照してください。0.2.1は依存関係以外の変更もあるようです。見直してください。他のバージョンも同様に。

Copy link
Copy Markdown
Contributor Author

Copilot AI commented Apr 1, 2026

@copilot 各タグ間の変更内容(diff & blame)も参照してください。0.2.1は依存関係以外の変更もあるようです。見直してください。他のバージョンも同様に�...

タグ間のdiffを確認しました。以下の漏れを修正しました(commit 2c2b956):

@gifnksm
Copy link
Copy Markdown
Owner

gifnksm commented Apr 1, 2026

@copilot 0.2.1より前のバージョンについても見直せますか?また、拙い英語で書かれているので、表現も見直せるとベターです

Copy link
Copy Markdown
Contributor Author

Copilot AI commented Apr 1, 2026

@copilot 0.2.1より前のバージョンについても見直せますか?また、拙い英語で書かれているので、表現も見直せるとベターです

Reviewed all versions through 0.1.0 and improved the English throughout (commit c8359c7):

  • [Unreleased]: Removed incorrect "Migrated to Rust edition 2024" (edition is still 2021); corrected MSRV baseline to "was 1.78.0"; added note about template variable validation
  • [0.2.2]: Added "was 1.74.0" to the MSRV note
  • [0.2.1]: Added missing MSRV bump to 1.74.0 (was 1.70.0)
  • [0.2.0]: Added a missing Added section for the vendored-libgit2 and vendored-openssl feature flags (PR Cargo.toml: Add vendored-libgit2 and vendored-openssl features #297); restructured the breaking change description with clearer wording and fixed a typo (missing space before backtick)
  • [0.1.1]: Improved phrasing of the config optionality fix

Copilot AI changed the title docs: curate CHANGELOG — fill empty release sections, compress dependency noise docs: curate CHANGELOG — fill all release sections, fix accuracy, improve English Apr 1, 2026
@gifnksm
Copy link
Copy Markdown
Owner

gifnksm commented Apr 1, 2026

@copilot CHANGELOGからpull reqのリンクはあった方が良いでしょうか?また、古いバージョンについても変更内容を確認して漏れがないことは確かめましたか?コミットメッセージに言及なく変更があった可能性もあります。

Copy link
Copy Markdown
Contributor Author

Copilot AI commented Apr 1, 2026

@copilot CHANGELOGからpull reqのリンクはあった方が良いでしょうか?また、古いバージョンについても変更内容を確認して漏れがないことは確かめました...

I've added PR links to all entries (commit af82747) and confirmed completeness by diffing every pair of adjacent tags directly rather than relying on commit messages alone. Summary of findings:

Completeness check (diff-based, not message-based):

  • [0.1.1]: only #[serde(default)] on root/query — already captured
  • [0.1.2]: repository cache + internal module reorganization (no user-facing impact beyond the cache) — already captured
  • [0.2.0]: vendored feature flags + breaking system-libs default — both now captured
  • [0.2.1]: dunce::canonicalize UNC fix + MSRV bump — both captured
  • [0.2.2]: MSRV bump only — captured
  • [Unreleased]: MSRV went through several intermediate steps (1.78→1.81→1.82→1.85→1.88); edition is still 2021 — summarised as "bumped to 1.88.0 (was 1.78.0)"

PR links: Added links for every substantive entry across all versions. For dependency-update-only bullets I omitted links since those span many PRs.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • https://api.github.com/repos/gifnksm/souko/compare/v0.1.0...v0.1.1
    • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/ghcca-node/node/bin/node --enable-source-maps /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js (http block)
  • https://api.github.com/repos/gifnksm/souko/compare/v0.1.1...v0.1.2
    • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/ghcca-node/node/bin/node --enable-source-maps /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js (http block)

If you need me to access, download, or install something from one of these locations, you can either:

Copilot AI changed the title docs: curate CHANGELOG — fill all release sections, fix accuracy, improve English docs: curate CHANGELOG — fill all release sections, fix accuracy, improve English, add PR links Apr 1, 2026
@gifnksm gifnksm marked this pull request as ready for review April 1, 2026 16:47
@gifnksm gifnksm requested a review from Copilot April 1, 2026 16:47
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 1, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.97%. Comparing base (101a462) to head (bf35172).
⚠️ Report is 7 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #648   +/-   ##
=======================================
  Coverage   85.97%   85.97%           
=======================================
  Files          31       31           
  Lines        1882     1882           
  Branches     1882     1882           
=======================================
  Hits         1618     1618           
  Misses        193      193           
  Partials       71       71           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Curates CHANGELOG.md to improve completeness and accuracy across past releases and the current Unreleased section, focusing on user-relevant changes and adding traceability via PR links.

Changes:

  • Filled previously empty/incomplete release sections with missing feature/fix/MSRV notes.
  • Improved wording/structure for clarity (including breaking-change wording for v0.2.0).
  • Added PR links for many entries to improve traceability.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread CHANGELOG.md Outdated
Comment thread CHANGELOG.md
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@gifnksm gifnksm enabled auto-merge April 1, 2026 16:52
@gifnksm gifnksm merged commit 8bb8e9d into main Apr 1, 2026
53 checks passed
@gifnksm gifnksm deleted the copilot/update-changelog-with-missing-details branch April 1, 2026 16:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants