aozoraflow

Operation rules and tools to manage Aozora-bunko text files in a Git repository

Aozoraflowとは

Aozoraflowは「青空文庫のテキストをGitリポジトリで管理する為の運用規約」と「それをサポートするためのツール」です。

運用規約

運用規約はちょうどVincent Driessenさんのブランチングモデルで述べられているような、ブランチの作成・消去のルールです。実際、Aozoraflowはこのgit-flowブランチングモデルから大きな影響を受けています。さらにGitHubで広く知られることになったプルリクエストのモデルを組み合わせています。

リポジトリの単位

作品毎にひとつのGitリポジトリを作ります。リポジトリ名は{作品ID}.gitになります。

ブランチの種別

1. editブランチ

   編集中テキストが置かれるブランチ。実際の修正自体は後述のtypingブランチおよびproofingブランチで行われ、editブランチへはmergeされる事により変更が反映される。

2. typingブランチ

   入力中のテキストが置かれるブランチ

3. proofingブランチ

   校正中のテキストが置かれるブランチ

4. masterブランチ

   現在公開されている、あるいは過去に公開されたテキストが置かれるブランチ

タグの種別

1. TYPE_COMPLETE

   全ての入力が完了したことを示すタグ

2. PROOF_COMPLE

   全ての校正が完了し、いつでも公開可能な状態であることを示すタグ

3. PUBLISHED

   現在公開中のバージョンを示すタグ

各作業の流れ

入力作業

1. editブランチから枝分かれしてtypingブランチを作成する。
2. 入力途中でも変更を適宜typingブランチにコミットする。
3. 入力が完了したら、editブランチに対してマージするためのプルリクエストを出す。
4. リポジトリ管理者はプルリクエストを確認し、問題なければeditブランチにマージする。
5. 全ての入力が完了したらTYPE_COMPLETEのタグを付ける

校正作業

1. editブランチから枝分かれしてproofingブランチを作成する。
2. 校正での修正を適宜proofingブランチに対してコミット。
3. 校正が完了したら、editブランチに対してマージするためのプルリクエストを出す
4. リポジトリ管理者はプルリクエストを確認し、問題なければeditブランチにマージする
5. 全ての校正が完了したらPROOF_COMPLETEのタグを付ける

公開作業

1. 公開の基準を満たしていることを確認し、PROOF_COMPLETEのタグの付いたバージョンをmasterへマージする
2. マージしたコミットにPUBLISHEDのタグを付ける