CHANGELOG.mdについて

正式リリースの際に sakura-editor/sakura/CHANGELOG.md を更新します。

changelog-sakura のリポジトリで自動生成される CHANGELOG_without_issues.md を元に作成しています。

自動生成とラベル付けについて

changelog-sakura は主に下記のルールで CHANGELOG.md を作ってくれます。

• sakura-editor/sakura リポジトリの PR と Issue から作ってくれます。
• CI,management,refactoring,duplicate などのラベルが付いていると抽出されません。
  • 各ラベルの説明に【ChangeLog除外】と書いています。
  • 具体的には makeChangeLog.batのEXCLUDELABELS 記述のラベルが除外されます。
• 下記のルールで分類されます。

PRやIssueのラベル	分類
enhancement	機能追加
bug	バグ修正
specification change	仕様変更
上記以外のPR	その他変更
上記以外のIssue	Closed issues

 【sakura-editor/sakura リポジトリ】
    [PR と Issue]
        ↓
        ↓                 【sakura-editor/changelog-sakura リポジトリ】
     ラベル除外、自動分類    [AppVeyor + github-changelog-generator]
        ↓
    [CHANGELOG_without_issues.md]
        ↓
        ↓ リリース時に手動で整形してコミットする
        ↓
 【sakura-editor/sakura リポジトリ】
    [CHANGELOG.md]

リリース時にやること

• タグを打ったあとに、下記を順に行う。
• AppVeyor の https://ci.appveyor.com/project/sakuraeditor/changelog-sakura を開き、New Build ボタンを押す。押す権限がない場合は翌朝まで待つ。
• 自動生成された CHANGELOG_without_issues.md をダウンロードし、CHANGELOG.md にコピペし、コミットする。
  • ※Issue は不要なので Issue を除いた CHANGELOG_without_issues.md のほうをコピペしています。
• こんな感じのPRを作ります⇒ v2.4.0 リリースに伴うCHANGELOG.md反映 by takke · Pull Request #1300 · sakura-editor/sakura

CHANGELOG.md スナップショット

CHANGELOG.mdスナップショット

関連情報

• https://github.com/sakura-editor/changelog-sakura/pull/13
• https://github.com/sakura-editor/management-forum/issues/53
• https://github.com/sakura-editor/changelog-sakura/issues/3
• https://github.com/sakura-editor/changelog-sakura/pull/1