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

v2.4.0 リリースに伴うCHANGELOG.md反映。 #1232

Closed
wants to merge 1 commit into from
Closed

v2.4.0 リリースに伴うCHANGELOG.md反映。 #1232

wants to merge 1 commit into from

Conversation

KENCHjp
Copy link
Member

@KENCHjp KENCHjp commented Apr 19, 2020

PR の目的

v2.4.0 リリースに伴うCHANGELOG.md反映です。

カテゴリ

  • ドキュメント修正

PR の背景

PR のメリット

PR のデメリット (トレードオフとかあれば)

PR の影響範囲

関連チケット

参考資料

@m-tmatma
Copy link
Member

すみません。見れてません。

- 検索条件の文字列をエスケープする処理を関数化する [\#1132](https://github.com/sakura-editor/sakura/pull/1132) ([berryzplus](https://github.com/berryzplus))
- 未初期化のout変数を参照しないため戻り値をチェックするようにする [\#1120](https://github.com/sakura-editor/sakura/pull/1120) ([berryzplus](https://github.com/berryzplus))
- \#1117 で入れた修正のうち master に入れるべきではない修正を取り除いて取り込む [\#1118](https://github.com/sakura-editor/sakura/pull/1118) ([m-tmatma](https://github.com/m-tmatma))
[Full Changelog](https://github.com/sakura-editor/sakura/compare/v2.4.0-beta5...v2.4.0)
Copy link
Contributor

Choose a reason for hiding this comment

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

v2.4.0-beta5 と v2.4.0 の比較だと内容が少ない(バージョン表記の変更だけ)ですが、その下の変更項目はたくさん出力されているのが気になります。beta の変更が全部出てる感じですかね?
それであれば、v2.3.2.0 と v2.4.0 の比較のリンクにするのはどうかなと思いました。

Copy link
Member Author

Choose a reason for hiding this comment

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

出だしの数行が追加されただけなのですが、不用意にマッチングされて、以降が互い違いにアンマッチになってるのかなと思っています、実質冒頭のみが追加されているだけのはずなのですが・・・

Copy link
Member Author

@KENCHjp KENCHjp Apr 24, 2020

Choose a reason for hiding this comment

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

と思ってたのですが、再度みたら、おかしいですね、CHANGELOG。。。

機械的に冒頭だけ消しただけだったので下のほう見てなかったのですが、ちょっと今生成されているCHANGELOG見てみます。

Copy link
Member Author

@KENCHjp KENCHjp Apr 24, 2020

Choose a reason for hiding this comment

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

ああ、すいません、よく見てなかったのが悪かったのですが、生成されているCHANGELOGが2.3.2から一気に2.4.0の差分の所になって、今までのalphaとかbeta各々に分解されていないっすね。

beta5の時にはさぼっていてCHANGELOG作ってなかったですが、beta4まではちゃんと各々リリース毎に生成されているので、なにか変更入ったのか、メジャーリリースされるとそっからの差分で生成されるのか・・・いやでも、タグだけを追っかけてるだけだからそれはないか。。。

CHANGELOG といえば @takke さん。。。(と声掛けしてしまうwww)

Copy link
Member

Choose a reason for hiding this comment

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

sakura-editor/changelog-sakura#30
を作ってみましたが、期待したのと違う

Copy link
Member

Choose a reason for hiding this comment

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

おや、勘違いしているかもしれませんが、
beta や alpha は出したいのですか?

正式リリースしたら beta や alpha はいらないと思うのですが。

Copy link
Member

Choose a reason for hiding this comment

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

個人的には正式リリース後も beta や alpha の ChangeLog は CHANGELOG.md には残すべきだと考えています。
alpha 版や beta 版を使っていた人に、それ以降の修正内容をお知らせする意味があります。
(ほぼ部外者の意見なのでお任せします)

Copy link
Member Author

Choose a reason for hiding this comment

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

個人的には、

リリースしてるものも含め、alphaやbetaは消してもいいかなと思っていますが、
GitHubではtagを消さないとリリースの所も消えないようで、一度リリースしているので、
alphaやbetaもリリース物としてとらえると、途中のbetaやalphaの各々も差分として表れててもいいかなと。

着地地点は「運用が楽な方」、alphaやbetaをきれいにするのに工数がかかるなら、そのままでいいかなと。
なのでtakkeさんに乗ろうかと。

Copy link
Member

Choose a reason for hiding this comment

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

現状把握しました。
(通知メールで読んでたので呼ばれてるのに気づきませんでした。edit分は通知メールで来ないので。。)

私も、運用が楽ならどちらでもいいと思うんですが、現状はどちらをやろうとしても問題があるんですね。

体調が悪く自社の仕事だけで手一杯なので時間ができたときに調べてみようと思います。

Copy link
Member Author

Choose a reason for hiding this comment

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

(通知メールで読んでたので呼ばれてるのに気づきませんでした。edit分は通知メールで来ないので。。)

失礼しました。

体調が悪く自社の仕事だけで手一杯なので時間ができたときに調べてみようと思います。

了解、お身体とお仕事優先で!

@takke
Copy link
Member

takke commented May 4, 2020

シンプルなリポジトリを作り試してみました。

  • v2.4.0-beta1, v2.4.0-beta2, v2.4.0 というタグを打って PR を行い、どんな CHANGELOG が生成されるのか確認しました。

  • 現在使っている github_changelog_generator-1.15.0.pre.beta では少しおかしい結果になりました。v2.4.0-beta1 の前に行ったPRが v2.4.0-beta2 に現れる、などです。

  • 最新の github_changelog_generator-1.15.2 を使うと想定通りの結果になりました。

というわけで、まずは github_changelog_generator を最新にして実行してみたいところですが、
sakura-editor/sakura に対して 1.15.2 で実行すると、stack level too deep が発生する問題 (sakura-editor/changelog-sakura#17) があるので、そちらを調査・解消する必要があります。

ようやくローカルに github_changelog_generator の環境を作り直せたので、ぼちぼち調べます。

@takke
Copy link
Member

takke commented May 4, 2020

stack level too deep を強引に回避し、github_changelog_generator の最新の master で実行して CHANGELOG を作ってみました。

1.15.2でsakura editor sakuraから強引に生成したCHANGELOG_without_issues.md

結果的には このPRの結果 よりもさらに悪く、全ての項目が 「v2.4.0」欄に出力されました。

取り急ぎ。

@takke
Copy link
Member

takke commented May 8, 2020

現在使っている github_changelog_generator-1.15.0.pre.beta のままで、 specify --no-filter-by-milestone option by takke · Pull Request #31 · sakura-editor/changelog-sakura の修正を行うことで、beta や alpha が出るようになりました。こちらの出力結果で CHANGELOG.md を更新されると良いかと思います。

@KENCHjp
Copy link
Member Author

KENCHjp commented May 8, 2020

いったんこっち閉じて改めます。

@KENCHjp KENCHjp closed this May 8, 2020
@beru beru added the no-changelog 【ChangeLog除外】 label Jul 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog 【ChangeLog除外】
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants