Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
May 11, 2020

Conversation

takke
Copy link
Member

@takke takke commented May 7, 2020

sakura-editor/sakura#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
Copy link

beru commented May 7, 2020

変更後の CHANGELOG_without_issues.md で Unreleased の

  • 仕様変更

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

@beru
Copy link

beru commented May 7, 2020

変更前には

  • バグ修正

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

  • Closed issues

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

@takke
Copy link
Member Author

takke commented May 8, 2020

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

変更後の 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
Copy link
Member Author

takke commented May 8, 2020

変更前には

  • バグ修正

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

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

#28

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

  • Closed issues

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

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

@takke takke force-pushed the add-no-filter-by-milestone branch from ceaf4d4 to a6ecd60 Compare May 8, 2020 01:18
@takke
Copy link
Member Author

takke commented May 8, 2020

Copy link

@beru beru left a comment

Choose a reason for hiding this comment

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

問題無いと思います。

バグ修正 の分類が出るようになったことを確認しました。

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

@takke
Copy link
Member Author

takke commented May 11, 2020

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

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

ここで消しています↓

perl -pe "{binmode(STDOUT)} s/^-.*\/issues\/\d+\)\n//g; s/\*\*Closed issues:\*\*\n//g;" %OUTFILENAME% > %OUTFILENAME_WITHOUT_ISSUES%

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

@takke takke merged commit d886920 into sakura-editor:master May 11, 2020
@takke takke deleted the add-no-filter-by-milestone branch May 11, 2020 04: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.

2 participants