-
Notifications
You must be signed in to change notification settings - Fork 163
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
CHANGELOG.md を追加する #813
Conversation
ありがとうございます。 Appveyor で生成したままのものをそのままコミットしていただいて、 またappeyor のどのビルドかという情報もコミットログに欲しいです。 ※ rebase で修正頂きたいです。 |
確かにそうですね。変更しました。
コミットログに appveyor の URL を含めました。 |
これのコミットに合わせて、タグ(v2.4.0.0 alpha1)付け? |
タグに規則があるみたいっすね。 v2.4.0.0-alpha1 これなら通る(スペースが通らないのかな) v2.4.0-alpha1 こうっすかね。 |
手作業の修正をしなくてもいいように以下の PR を作ってみましたが、 なんか期待と違う。 |
v2.4.0-alpha1 のタグを下記コマンドで打って、そのタグを参照するように CHANGELOG.md を修正しました。
|
@@ -0,0 +1,236 @@ | |||
# Change Log |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change Logs
もしくは Changelog
が良いと思います。
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
きのこたけのこ戦争みたいなものだと思います。
There was a problem hiding this comment.
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)) |
There was a problem hiding this comment.
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 のタイトルを変えてから生成しなおせば直せそうでしょうか?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Issue (というか PR ですよね?) のタイトルから自動生成しているのでそちらを直していただければ。
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Issue #716 のタイトルを更新しました。
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ありがとうございます!
そしてこのPRは個人的に新バージョンの目玉機能の1つだと感じているので分かりやすくなって嬉しいです。
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Issue ではなくて PR でした。
There was a problem hiding this comment.
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)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Issueのタイトルから生成していてこうなってしまっていると思いますが、[拾い物です]
というのはユーザーからするとなんのこっちゃという感じなのでIssueのタイトルから削った方が良さそうですね。
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PR #704 のタイトルから [拾い物です]
というのを削りました。
There was a problem hiding this comment.
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)) |
There was a problem hiding this comment.
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のタイトルを変えた方が良いと思います。特定のファイルで描画が遅くなる問題への対策
とかで良いと思います。
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PR #792 のタイトルを更新しました。
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
CHANGELOG.mdを生成し直して修正しました。
There was a problem hiding this comment.
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
の部分を日本語にしました。
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
CHANGELOG.mdを生成し直して修正しました。
任意のタイミングで CHANGELOG.md を再生成したいのですが Appveyor の実行権限みたいなものもらえますか? > @m-tmatma さん |
サクラエディタの開発メンバーは全員権限がすでに付与されています。 https://ci.appveyor.com/login |
GitHub のアカウントでログインし直してみたところ、左上のドロップダウンに 自分のプロジェクトのほうは "New Build" ボタンがちゃんと出るのですが・・・。 ひとまず早朝のビルド結果を使って作業進めますね。 |
最新の 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の手順と同様に、
という手順を辿るのが良さそうです。 あれ?でもサクラエディタの場合はリリース前のバージョン変更コミットいらないのかな?既に v2.4.0 になってますもんね。 |
ここは、運用しながらですね。 |
https://ci.appveyor.com/project/sakuraeditor/changelog-sakura |
ですよね!いま v2.4.0 と表記されてるのは分かりやすくて素敵なんですが、リリース時にどうバージョン表記するかは未定って感じですかね。 リリース版は AppVeyor ではなくどなたかがローカルでビルドしたものを使うとして、そのときは AppVeyor 版とは違うバージョン表記になるので "v2.4.0-alpha1" みたいにバージョン情報に表示できるという理解でいいですかね(以前ソースざっくり読んだ限りそう書かれていたかと)。 リリース担当者必要っすね。。 |
wikiで ゆくゆくはどうにかして自動化したいところですけど、あまり複雑にするのもあれなので。 |
本チャンも、 AppVeyorから持ってこようと思っておりますです。個人の環境の生成物だと差異があったときに拾えないかなと思うので。 ここのコメント伸ばさずに、 |
はい、ローカルビルドはあくまで開発用で、 appeyor でビルドした時に定義される専用のマクロがあって githash.bat を見ていただくとわかると思います。 |
CHANGELOG.md を生成し直して修正しました。次のバージョンは未定なので Unreleased としています。 v2.4.0-alpha1 は一応リリース済みなのでそろそろ CHANGELOG.md も master に取り込みたいです。。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
いいと思います。
なお #818 をマージしたら md ファイルの変更を appveyor は無視してくれるようになるので |
CHANGELOG.md を追加する
3/27 にとりあえずリリースということなのでせめて CHANGELOG.md くらいは用意しないと誰も評価できないと思うので追加しました。
作成方法は CHANGELOG.mdについて · sakura-editor/sakura Wiki の wiki に書いてあるとおりです。
バージョン番号部分は自動生成だと
Unreleased
ですがかっこ悪いのでv2.4.0.0 alpha1
にしました。決まり次第変えましょう。