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

CHANGELOG.md を追加する #813

Merged
merged 5 commits into from
Mar 31, 2019
Merged

Conversation

takke
Copy link
Member

@takke takke commented Mar 25, 2019

3/27 にとりあえずリリースということなのでせめて CHANGELOG.md くらいは用意しないと誰も評価できないと思うので追加しました。

作成方法は CHANGELOG.mdについて · sakura-editor/sakura Wiki の wiki に書いてあるとおりです。

バージョン番号部分は自動生成だと Unreleased ですがかっこ悪いので v2.4.0.0 alpha1 にしました。決まり次第変えましょう。

@m-tmatma
Copy link
Member

ありがとうございます。

Appveyor で生成したままのものをそのままコミットしていただいて、
その後のコミットで、調整した方がいいです。
そうでないと、どの部分を手動修正したか追跡しにくいです。

またappeyor のどのビルドかという情報もコミットログに欲しいです。
これも後で追跡しやすくするためです。

※ rebase で修正頂きたいです。

@takke
Copy link
Member Author

takke commented Mar 25, 2019

Appveyor で生成したままのものをそのままコミットしていただいて、
その後のコミットで、調整した方がいいです。
そうでないと、どの部分を手動修正したか追跡しにくいです。

確かにそうですね。変更しました。

またappeyor のどのビルドかという情報もコミットログに欲しいです。
これも後で追跡しやすくするためです。

コミットログに appveyor の URL を含めました。

@KENCHjp
Copy link
Member

KENCHjp commented Mar 25, 2019

これのコミットに合わせて、タグ(v2.4.0.0 alpha1)付け?

@KENCHjp
Copy link
Member

KENCHjp commented Mar 25, 2019

タグに規則があるみたいっすね。

v2.4.0.0-alpha1

これなら通る(スペースが通らないのかな)
末尾がビルド番号ってことだと、

v2.4.0-alpha1

こうっすかね。

@m-tmatma
Copy link
Member

v2.4.0.0-alpha1

これなら通る(スペースが通らないのかな)
末尾がビルド番号ってことだと、

v2.4.0-alpha1

手作業の修正をしなくてもいいように以下の PR を作ってみましたが、
sakura-editor/changelog-sakura#22

なんか期待と違う。

@takke
Copy link
Member Author

takke commented Mar 26, 2019

v2.4.0-alpha1 のタグを下記コマンドで打って、そのタグを参照するように CHANGELOG.md を修正しました。

$ git tag v2.4.0-alpha1
$ git push upstream v2.4.0-alpha1

@@ -0,0 +1,236 @@
# Change Log
Copy link
Contributor

Choose a reason for hiding this comment

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

Change Logs もしくは Changelog が良いと思います。

Copy link
Member Author

Choose a reason for hiding this comment

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

何か理由はありますか?

あまり例が見つかりませんがJavaの世界で最近よく使われているOkHttpというライブラリは Change Log と表記していますし個人的に違和感はないです。

https://github.com/square/okhttp/blob/master/CHANGELOG.md

Copy link
Contributor

Choose a reason for hiding this comment

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

きのこたけのこ戦争みたいなものだと思います。

Copy link
Member Author

Choose a reason for hiding this comment

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

では Change Log でいいですかね。

CHANGELOG.md Outdated

- Window テキストをCNativeT で取得/設定するユーティリティ関数を追加 [\#776](https://github.com/sakura-editor/sakura/pull/776) ([m-tmatma](https://github.com/m-tmatma))
- 開いているファイルのフォルダのパスをクリップボードにコピーできるようにする [\#718](https://github.com/sakura-editor/sakura/pull/718) ([m-tmatma](https://github.com/m-tmatma))
- Common File Dialog の代わりに Common Item Dialog を使用する [\#716](https://github.com/sakura-editor/sakura/pull/716) ([beru](https://github.com/beru))
Copy link
Contributor

Choose a reason for hiding this comment

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

Issueのタイトルから生成していると思うんですが、Common File Dialog の代わりに Common Item Dialog を使用する というのは正確な記載では無いですね。Vistaスタイルのファイルダイアログを使えるようにする が正しい説明ですね。Issue のタイトルを変えてから生成しなおせば直せそうでしょうか?

Copy link
Member Author

Choose a reason for hiding this comment

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

Issue (というか PR ですよね?) のタイトルから自動生成しているのでそちらを直していただければ。

Copy link
Contributor

Choose a reason for hiding this comment

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

Issue #716 のタイトルを更新しました。

Copy link
Member Author

Choose a reason for hiding this comment

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

ありがとうございます!
そしてこのPRは個人的に新バージョンの目玉機能の1つだと感じているので分かりやすくなって嬉しいです。

Copy link
Contributor

Choose a reason for hiding this comment

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

Issue ではなくて PR でした。

Copy link
Member Author

Choose a reason for hiding this comment

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

CHANGELOG.mdを生成し直して修正しました。

CHANGELOG.md Outdated
- Window テキストをCNativeT で取得/設定するユーティリティ関数を追加 [\#776](https://github.com/sakura-editor/sakura/pull/776) ([m-tmatma](https://github.com/m-tmatma))
- 開いているファイルのフォルダのパスをクリップボードにコピーできるようにする [\#718](https://github.com/sakura-editor/sakura/pull/718) ([m-tmatma](https://github.com/m-tmatma))
- Common File Dialog の代わりに Common Item Dialog を使用する [\#716](https://github.com/sakura-editor/sakura/pull/716) ([beru](https://github.com/beru))
- \[拾い物です\] 背景画像表示の不透明度を設定出来るように変更 [\#704](https://github.com/sakura-editor/sakura/pull/704) ([ds14050](https://github.com/ds14050))
Copy link
Contributor

Choose a reason for hiding this comment

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

Issueのタイトルから生成していてこうなってしまっていると思いますが、[拾い物です] というのはユーザーからするとなんのこっちゃという感じなのでIssueのタイトルから削った方が良さそうですね。

Copy link
Contributor

@beru beru Mar 26, 2019

Choose a reason for hiding this comment

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

PR #704 のタイトルから [拾い物です] というのを削りました。

Copy link
Member Author

Choose a reason for hiding this comment

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

CHANGELOG.mdを生成し直して修正しました。

CHANGELOG.md Outdated
### その他変更

- githash.batでgitを探すようにする [\#794](https://github.com/sakura-editor/sakura/pull/794) ([berryzplus](https://github.com/berryzplus))
- Feature/workaround for issue398 [\#792](https://github.com/sakura-editor/sakura/pull/792) ([berryzplus](https://github.com/berryzplus))
Copy link
Contributor

Choose a reason for hiding this comment

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

Feature/workaround for issue398 という説明だとページを辿らないと内容が分からないのでIssueのタイトルを変えた方が良いと思います。特定のファイルで描画が遅くなる問題への対策 とかで良いと思います。

Copy link
Contributor

Choose a reason for hiding this comment

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

PR #792 のタイトルを更新しました。

Copy link
Member Author

Choose a reason for hiding this comment

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

CHANGELOG.mdを生成し直して修正しました。

Copy link
Member

Choose a reason for hiding this comment

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

PR #792 のタイトルを更新しました。

Feature/workaround for issue398 の部分を日本語にしました。

Copy link
Member Author

Choose a reason for hiding this comment

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

CHANGELOG.mdを生成し直して修正しました。

@takke
Copy link
Member Author

takke commented Mar 26, 2019

任意のタイミングで CHANGELOG.md を再生成したいのですが Appveyor の実行権限みたいなものもらえますか? > @m-tmatma さん

@m-tmatma
Copy link
Member

任意のタイミングで CHANGELOG.md を再生成したいのですが Appveyor の実行権限みたいなものもらえますか? > @m-tmatma さん

サクラエディタの開発メンバーは全員権限がすでに付与されています。

https://ci.appveyor.com/login
にアクセスした後、"GitHub" のアイコンを押すと GitHub のアカウントでログインできるので
https://ci.appveyor.com/project/sakuraeditor/changelog-sakura
にアクセスして "New Build" を押せば (changelog-sakura の) master に対してビルドが走ります。

@takke
Copy link
Member Author

takke commented Mar 27, 2019

https://ci.appveyor.com/login
にアクセスした後、"GitHub" のアイコンを押すと GitHub のアカウントでログインできるので
https://ci.appveyor.com/project/sakuraeditor/changelog-sakura
にアクセスして "New Build" を押せば (changelog-sakura の) master に対してビルドが走ります。

GitHub のアカウントでログインし直してみたところ、左上のドロップダウンに sakuraeditor が出てきたのでログイン自体は問題なさそうなのですが、"New Build" ボタンは出てきませんでした。

2019-03-27_09h24_08

自分のプロジェクトのほうは "New Build" ボタンがちゃんと出るのですが・・・。

2019-03-27_09h24_26

ひとまず早朝のビルド結果を使って作業進めますね。

@takke
Copy link
Member Author

takke commented Mar 27, 2019

最新の CHANGELOG.md を反映しました。

1点補足ですが、#808 が当初の CHANGELOG.md に含まれていなかったので追加しました。

今朝自動生成されたCHANGELOG.md では、#808 が Unreleased に含まれていますが、手動で v2.4.0-alpha1 に移動しています。

これは、「v2.4.0-alpha1 タグを #808 のマージコミットに付けた」のですが、 「#808 はマージコミット後に閉じられた」ため、時間的に v2.4.0-alpha1 タグ以降のものと判定されてしまったためです。

今後はこの現象を回避するために、よくあるOSSの手順と同様に、

  • バージョンの変更コミット (いわゆる bump up version number to XXX)
  • タグ打ち
  • CHANGELOG.md 生成と更新
  • リリース

という手順を辿るのが良さそうです。

あれ?でもサクラエディタの場合はリリース前のバージョン変更コミットいらないのかな?既に v2.4.0 になってますもんね。

@KENCHjp
Copy link
Member

KENCHjp commented Mar 27, 2019

ここは、運用しながらですね。
以前の議論で開発中かどうかわかった方がいいよねっていうのと、バージョン上げないと今のリリースと被るからどうするかって議論がありまして。

@KENCHjp
Copy link
Member

KENCHjp commented Mar 27, 2019

https://ci.appveyor.com/project/sakuraeditor/changelog-sakura
こちら私も、NEW BUILDでますね。
userとadminの違いのようですね。

@KENCHjp
Copy link
Member

KENCHjp commented Mar 27, 2019

run build とview権限をuser(git hub側のdeveloper)に付与してみました。
キャプチャ

@takke
Copy link
Member Author

takke commented Mar 27, 2019

以前の議論で開発中かどうかわかった方がいいよねっていうのと、バージョン上げないと今のリリースと被るからどうするかって議論がありまして。

ですよね!いま v2.4.0 と表記されてるのは分かりやすくて素敵なんですが、リリース時にどうバージョン表記するかは未定って感じですかね。

リリース版は AppVeyor ではなくどなたかがローカルでビルドしたものを使うとして、そのときは AppVeyor 版とは違うバージョン表記になるので "v2.4.0-alpha1" みたいにバージョン情報に表示できるという理解でいいですかね(以前ソースざっくり読んだ限りそう書かれていたかと)。
そのためにソースコードを修正するとしたら、そのコミットをどこかでしていただきたい感じです。
今回はとりあえず AppVeyor から持ってきたものを公開でも全然かまわないです。

リリース担当者必要っすね。。

@takke
Copy link
Member Author

takke commented Mar 27, 2019

run build とview権限をuser(git hub側のdeveloper)に付与してみました。

なるほど、ありがとうございます!
"NEW BUILD" ボタン出ました!

2019-03-27_10h18_21

@KENCHjp
Copy link
Member

KENCHjp commented Mar 27, 2019

リリース担当者必要っすね。。

wikiでリリース時にやること(案)のところ具体的な手順って起してもらうのお願いできますか?
(できたらサクラエディタ使ってやれるのがベスト)
手が空いてる時でいいです全然すぐでなくていいです。
私でもできるように(笑)

ゆくゆくはどうにかして自動化したいところですけど、あまり複雑にするのもあれなので。

@KENCHjp
Copy link
Member

KENCHjp commented Mar 27, 2019

今回はとりあえず AppVeyor から持ってきたものを公開でも全然かまわないです。

本チャンも、 AppVeyorから持ってこようと思っておりますです。個人の環境の生成物だと差異があったときに拾えないかなと思うので。

ここのコメント伸ばさずに、
sakura-editor/management-forum#52
こっちに継続したほうがいい話かもしれませんが。

@m-tmatma
Copy link
Member

今回はとりあえず AppVeyor から持ってきたものを公開でも全然かまわないです。

本チャンも、 AppVeyorから持ってこようと思っておりますです。個人の環境の生成物だと差異があったときに拾えないかなと思うので。

はい、ローカルビルドはあくまで開発用で、
公開用は appeyor ビルドを想定してます。

appeyor でビルドした時に定義される専用のマクロがあって
それを参照することによって、バージョン情報ダイアログで
どういうビルドかわかるようになっています。

githash.bat を見ていただくとわかると思います。

@KENCHjp KENCHjp added management 運営に関する話題 【ChangeLog除外】 Release Release作業チケット【ChangeLog除外】 labels Mar 28, 2019
@takke takke changed the title Add CHANGELOG.md CHANGELOG.md を追加する Mar 28, 2019
@takke
Copy link
Member Author

takke commented Mar 31, 2019

CHANGELOG.md を生成し直して修正しました。次のバージョンは未定なので Unreleased としています。

v2.4.0-alpha1 は一応リリース済みなのでそろそろ CHANGELOG.md も master に取り込みたいです。。

Copy link
Member

@m-tmatma m-tmatma left a comment

Choose a reason for hiding this comment

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

いいと思います。

@m-tmatma
Copy link
Member

なお #818 をマージしたら md ファイルの変更を appveyor は無視してくれるようになるので
不必要にビルドが走らなくなります。

@takke takke merged commit 2f5395a into sakura-editor:master Mar 31, 2019
@takke takke deleted the add_changelog branch March 31, 2019 13:05
@m-tmatma m-tmatma added this to the v2.4.0 milestone Apr 28, 2019
HoppingTappy pushed a commit to HoppingTappy/sakura that referenced this pull request Jun 11, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
management 運営に関する話題 【ChangeLog除外】 Release Release作業チケット【ChangeLog除外】
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants