sakura-editor / changelog-sakura

changelog for sakura
MIT License
1 stars 3 forks source link

specify --no-filter-by-milestone option #31

Closed takke closed 4 years ago

takke commented 4 years ago

https://github.com/sakura-editor/sakura/pull/1232 で v2.4.0 に ChangeLog が出力される件の修正用です。

どうやら、github_changelog_generator はデフォルトだと「マイルストーン」単位で PR や Issue を紐付けるようです。v2.4.0 をリリースしたことでマイルストーンが出現し、それまでのように alpha/beta 版のリリースに PR 項目が出力されなくなってしまったようです。

というわけで、--no-filter-by-milestone オプションを追加し、マイルストーンに優先されないように変更しました。

出力結果は https://ci.appveyor.com/project/takke/changelog-sakura-djw7o/builds/32712604/artifacts にあるのでご確認ください。

beru commented 4 years ago

変更前(#1232 から)

https://github.com/sakura-editor/sakura/blob/3939a797935738f60d289701811e461d6d566a0f/CHANGELOG.md

変更後

https://ci.appveyor.com/api/buildjobs/y90iwynixi45hb8q/artifacts/CHANGELOG.md

https://ci.appveyor.com/api/buildjobs/y90iwynixi45hb8q/artifacts/CHANGELOG_without_issues.md

beru commented 4 years ago

変更後の CHANGELOG_without_issues.md で Unreleased の

の見出しが項目が無いのに出てるのが気になります。

beru commented 4 years ago

変更前には

という文類が有ったんですが変更後には無くなってしまっているのが気になります。

という見出しが変更後の出力の CHANGELOG.md にあるのも気になります。

takke commented 4 years ago

ご確認ありがとうございます。

変更後の CHANGELOG_without_issues.md で Unreleased の

  • 仕様変更

の見出しが項目が無いのに出てるのが気になります。

変更後の CHANGELOG.md を見ていただくと分かりますが

Grep機能のうち一部機能を削除しませんか? [\#1248](https://github.com/sakura-editor/sakura/issues/1248)

というissueの項目があり、これを削ったのが CHANGELOG_without_issues.md です。 削るのは、現在は Perl のスクリプトで強引に行っているため、カテゴリ自体が残ってしまうことがあります。 本来は github_changelog_generator--no-issues オプションで消すべきですが、これをやると「仕様変更」「その他変更」といったカテゴリ自体が出力されなくなるので、スクリプトで強引に削っています。 (github_changelog_generator を新しくするとこの問題は解消しますがまた別の問題がいくつかあります)

takke commented 4 years ago

変更前には

  • バグ修正

という文類が有ったんですが変更後には無くなってしまっているのが気になります。

確かになくなっていて「その他変更」に含まれるようになっちゃってますね。

https://github.com/sakura-editor/changelog-sakura/issues/28

の修正を取り込み忘れていました。 作り直します。

  • Closed issues

という見出しが変更後の出力の CHANGELOG.md にあるのも気になります。

その行も Perl で消しているので変更前の CHANGELOG.md にはありません。

takke commented 4 years ago

rebase して force push しました。

出力結果はこちらです。

https://ci.appveyor.com/project/takke/changelog-sakura-djw7o/builds/32730510/artifacts

https://ci.appveyor.com/api/buildjobs/2xf7hjbg73sr1fbs/artifacts/CHANGELOG.md

https://ci.appveyor.com/api/buildjobs/2xf7hjbg73sr1fbs/artifacts/CHANGELOG_without_issues.md

「バグ修正」の分類が出ています。

takke commented 4 years ago

レビューありがとうございます。

Closed issues については Perl スクリプト(どの?)で消すという事なので、おそらく CHANGELOG.md を更新する PR を作成する人が手元で行うんですかね?

ここで消しています↓ https://github.com/sakura-editor/changelog-sakura/blob/5562714d6489b0fb6daaac5e0c7a74430bd3bdd3/makeChangeLog.bat#L61

これにより、CHANGELOG_without_issues.md からは消えています。