[groonga-commit:4022] ranguba/packnga [master] add release.textile.

Fri Sep 16 02:23:13 EDT 2011

yoshihara haruka	2011-09-16 06:23:13 +0000 (Fri, 16 Sep 2011)

  New Revision: 2b48b90c899eaed3a810f1ba46f5b87be1f9ac81

  Log:
    add release.textile.

  Added files:
    doc/text/release.textile

  Added: doc/text/release.textile (+302 -0) 100644
===================================================================

--- /dev/null
+++ doc/text/release.textile    2011-09-16 06:23:13 +0000 (549a9cb)
@@ -0,0 +1,302 @@
+h1. リリース手順
+
+h2. news.rdocに前回リリースからの変更点のまとめ
+
+news.rdocに前回のリリース時から現在までの変更点をnews.rdocにまとめるため、下記コマンドを実行してgitのコミットログを表示する。
+
+<pre>
+$ git log -p --reverse （リリースバージョン)..
+</pre>
+
+ログを"Author:"で検索しながら、ユーザにとって知る必要があるもの（ユーザに見える情報）のコミットログのみを抜き出す。
+その動詞を過去形にする。
+それらログをそれぞれを次のようにまとめる。
+機能などに新しく追加されたものに関してはImprovement,
+動作の変更などはChanges,
+バグの修正など前バージョンまでにあった問題を修正したものはFixesに記述する。
+また、コミットログの行末に[人名]がある場合はその人名をThanks以下に書く。
+この作業をリリース予定日よりも前に行った場合は、news.rdocの先頭にコミットIDをメモしておく。
+
+h3. news.rdocの1リリース分のテンプレート
+
+<pre>
+h2. （リリースするバージョン）: リリース日（yyyy-mm-dd）
+
+h3. Improvements
+
+* 
+
+h3. Changes
+
+* 
+
+h3. Fixes
+
+* 
+
+h3. Thanks
+</pre>
+
+<pre>
+== （リリースするバージョン）: リリース日（yyyy-mm-dd）
+
+=== Improvements
+
+* 
+
+=== Changes
+
+* 
+
+=== Fixes
+
+* 
+
+=== Thanks
+
+* 
+
+</pre>
+
+TODO:テンプレをtextileにする
+
+h2. 日本語訳の作成
+
+下記コマンドを実行してja.poを更新する。
+
+<pre>
+$ rake reference:po:update
+</pre>
+
+その後、ja.poを開いて、各msgid（コミットログ）に対応するmsgstrにコミットログの和訳を作成する。
+
+h2. バージョンとリリース日の更新
+
+下記コマンドを入力して、プロジェクトページ（html/index.html、html/index.html.ja）のrroongaの項にある最新バージョンとリリース日をそれぞれ次回リリースに合わせたものに更新する。
+
+<pre>
+$ rake release:info:update OLD_VERSION=（現在のバージョン） OLD_RELEASE_DATE=（前回リリース日） RELEASE_DATE=（今回のリリース日）
+</pre>
+
+h2. gemパッケージの作成
+
+下記コマンドを打ってアップロード用のgemパッケージをビルドする。
+
+<pre>
+$ ruby1.8 -S rake build
+</pre>
+
+rroongaの場合、ruby1.9.1ではパースできないオブジェクトがあるためruby1.8で作成する。
+TODO: YAMLの設定ファイルを直して1.9.1でやる
+
+h2. gemパッケージの動作確認
+
+そのgemパッケージの動作を確認するため、下記コマンドを打ってローカル環境にインストールする。
+
+<pre>
+$ gem1.9.1 install pkg/rroonga-（バージョン番号）.gem --user-install
+</pre>
+
+インストールが成功すると/home/(ユーザ名)/.gem/ruby/1.9.1/gems/rroonga-（バージョン番号）/にインストールされる。
+このディレクトリに移動して、テストを実行し動作を確認する。
+
+<pre>
+$ NO_MAKE=yes ruby1.9.1 test/run-test.rb
+</pre>
+
+h2. news.rdocの再まとめ
+
+news.rdocの行頭にコミットIDが残っている場合、
+下記コマンドを実行してログを表示する。
+
+<pre>
+git log --reverse -p （リリースバージョン）..（残っていたコミットID）
+</pre>
+
+上記ログを"Author:"で検索しながら、ユーザにとって知る必要があるもの（ユーザに見える情報）のコミットログのみを抜き出す。
+その動詞を過去形にする。
+それらログをそれぞれを次のようにまとめる。
+機能などに新しく追加されたものに関してはImprovement,
+動作の変更などはChanges,
+バグの修正など前バージョンまでにあった問題を修正したものはFixesに記述する。
+また、コミットログの行末に[人名]がある場合はその人名をThanks以下に書く。
+
+その後、下記コマンドを実行してja.poを更新する。
+
+<pre>
+$ rake reference:po:update
+</pre>
+
+その後、ja.poを開いて、各msgid（追加したコミットログ）に対応するmsgstrにコミットログの和訳を作成する。
+
+h2. これまでの変更をpush
+
+ここまでに行った変更をcommitしてgit pushする。
+h2. リリースバージョンのタグを作成
+
+下記コマンドを入力して、今回リリースするバージョンのタグを打ってgit pushする。
+
+<pre>
+$ rake release
+$ git push --tag
+</pre>
+
+h2. rubygems.orgにパッケージをアップロード
+
+下記コマンドを実行してパッケージをアップロードする。
+
+<pre>
+$ ruby1.8 -S rake gemcutter:release
+</pre>
+
+h2. rubyforgeにパッケージをアップロード
+
+下記コマンドを実行してアップロードする。
+
+<pre>
+$ ruby1.8 -S rake release:rubyforge:upload
+$ ruby1.8 -S rake release:reference:publish
+$ ruby1.8 -S rake release:html:publish
+</pre>
+
+rroonga以外の場合、index.html関連はrake release:html:publishでアップロードされないので、rroonga側からアップロードする。
+
+h2. メーリングリストにリリースの周知
+
+メーリングリストにリリースした旨を書いたメールを流す。
+日本語の他、英語のメーリングリストにもリリースした旨を英語で書いたメールを流す。
+
+h3.日本語でのメールの具体例
+
+吉原です。
+
+（最新バージョンをリリースしたことを書く）
+groongaのRubyバインディングrroonga1.2.3をリリースしました。
+（rroongaのインデックスページのURL）
+  http://groonga.rubyforge.org/index.html.ja#about-rroonga
+
+（ソフトウェアの概略）
+rroongaはRubyらしい書き方でgroongaを操作できることを重視しています。
+同時に、groongaの速度をそのまま生かすことも大事にしています。
+
+（前回リリースから今回リリースまでに変更された点のうち、ユーザにとって重要なものを書く）
+1.2.1からの変更された点としては、ドキュメントの一部英訳化、リファ
+レンスのパスの修正などを行いました。また、rroongaをインストールし
+ようとした際、groongaがないと自動でインストールする機能が復活しま
+した。
+
+（コマンドなどのインストール方法）
+インストール:
+  % sudo gem install rroonga
+
+（チュートリアルページのURL）
+irbを使ったrroongaのチュートリアルはこちらにあります。
+
+  http://groonga.rubyforge.org/rroonga/ja/file.tutorial.html
+
+（http://groonga.rubyforge.org/rroonga/ja/file.news.htmlを見て、前回リリース時からの変更点を書く）
+1.2.1からの変更点は以下の通りです。
+
+1.2.3: 2011-06-27
+
+修正
+    gemパッケージに含まれてしまったオブジェクトファイル(*.o)を削除。
+    一部のリファレンスマニュアルの文字化けを修正。
+
+1.2.2: 2011-06-27
+
+改良
+    英語版の「開発者向け情報」ページを作成。
+    "html:publish"タスクと"publish"に関しての説明を追加。
+
+変更
+    Groonga::Record#attributesが重複したレコードが現れた際に
+    同じattributesオブジェクトを返すようにした。
+    Groonga::Record#attributesにドキュメントを追加。
+    「開発者向け情報」ページ内にあるドキュメント作成ツールを変更。
+    NEWS*.rdocとtutorial.texttileをディレクトリdoc/text/に移動。
+
+修正
+    インデックスページにある「チュートリアル」ページへのリンクを修正。
+    インデックスページにある英語版「チュートリアル」ページへのリンクを修正。
+    新しいgroongaのダウンロードURLに対応。 [mallowlabs]
+
+感謝
+    mallowlabsさん
+
+h3. 英語でのメールの具体例
+
+<pre>
+Everyone,
+
+（rroongaの再榛バージョンをリリースしたことを書く）
+We relesed rroonga 1.2.3.
+
+（インデックスページのURLを書く）
+  http://groonga.rubyforge.org/#about-rroonga
+
+（rroongaの説明）
+rroonga is the library which ruby-binding for grronga.
+
+（前回リリース時からの変更点のうち、ユーザにとって大事なものを書く）
+Since ver.1.2.1 was released, we translated some documents
+from Japanese to English, and fixed pathes in reference-manual.
+Thanks to mallowlabs, when installing rroonga without groonga
+installed, grronga is automatically installed.
+
+（インストール方法を書く）
+How to install:
+  % sudo gem install rroonga
+
+（チュートリアルについてのURLなどを書く）
+There is the tutorial of rroonga with irb:
+
+  http://groonga.rubyforge.org/rroonga/en/file.tutorial.html
+
+（news.rdocから今回リリースのために書いた部分をコピーする）
+Please see below changes since ver.1.2.1.
+
+== 1.2.3: 2011-06-27
+
+=== Fixes
+
+* remove object files in gem packages.
+* fix charactor corruption in reference.
+
+== 1.2.2: 2011-06-27
+
+=== Improvements
+
+* created "Developers" page in English.
+* added description for tasks of "html:publish" and "publish".
+
+=== Changes
+
+* Groonga::Record#attributes return same attributes object for duplicate records.
+* added document for Groonga::Record#attributes.
+* changed tool name in document page for creating document.
+* moved NEWS*.rdoc and tutorial.texttile to doc/text/.
+
+=== Fixes
+
+* fixed the tutorial path in index page.
+* fixed the path of tutorial in index page in English.
+* follow the groonga downlowd URL change. [mallowlabs]
+
+=== Thanks
+
+* mallowlabs
+
+--
+（名前とメールアドレス）
+yoshihara
+(yoshihara at clear-code.com)
+</pre>
+
+h2. rubyforgeのニュースを更新
+
+rubyforgeのpost_newsコマンドを使ってrubyforgeの最新ニュースを更新する。
+
+h2. 次回リリース時のバージョン番号の設定
+
+ext/groonga/rb-grn.hにある、RB_GRN_MAJOR_VERSION,RB_GRN_MINOR_VERSION,RB_GRN_MICRO_VERSIONの値を次回リリース時のバージョンの値に変更する。

