HowToRelease

「Ruby リファレンスマニュアル刷新計画」のリリース手順の説明です。

bitclust の gem リリース手順

2020年5月現在、 https://github.com/rurema/bitclust からの gem のリリースは https://github.com/rurema/bitclust/blob/master/.github/workflows/gempush.yml で半自動化されています。

• rubygems.org にログイン
• https://rubygems.org/profile/edit で MFA Level を UI Only に下げる
• https://github.com/rurema/bitclust/settings/secrets で RUBYGEMS_AUTH_TOKEN を設定
• タグを push

% git pull
Already up to date.
% git grep -F 1.2.5
lib/bitclust/version.rb:  VERSION = "1.2.5"
% git tag -s -m '' v1.2.5
% git push --tags

• GitHub Actions のログで gem push ができているのを確認
• Secret から RUBYGEMS_AUTH_TOKEN を Remove
• MFA Level を UI and API に戻す
• lib/bitclust/version.rb を更新

以下、obsolete

以下は古い内容で、2020年現在は生成したマニュアルのリリースはしていませんが、そのまま残しておきます。

リリースするものとそのファイル名

リリース物	ファイル名(案)
パッケージ版	ruby-refm-x.y.z-dynamic.tar.gz, zip, tar.bz2
chm版	ruby-refm-x.y.z-chm.zip
web版	http://doc.loveruby.net/refm/api/
静的html版 (将来的に)	rubyrefm-x.y.z-html.tar.gz
info版 (将来的に)	rubyrefm-x.y.z-info.tar.gz

リリース手順

仮のリリース手順を書いておきます。今回のリリースが終わったら、それを振り返りつつ追記してください。

1. リリース物を作る(後述)
2. リリースのアナウンス文を書く
3. アナウンス文のレビュー (ML にて)((-省略可-))
4. Git レポジトリにリリースタグを打つ
5. リリースパッケージを作ってサイトに置く
6. ruby-list にリリースのアナウンス
7. ruby-lang.org にリリースのアナウンス

リリース物の作り方

パッケージ版

まず bitclust と doctree を git clone しておきます。clone 済みの場合は git pull --rebase で最新にします。

$ git clone https://github.com/rurema/bitclust.git
$ git clone https://github.com/rurema/doctree.git

Windows環境の場合はexerbと7-zip32.dllとtar32.dllを入れておきます。 Windows以外の環境の場合は7za,zip,tar,gzip,bzip2を入れておきます。

$ ruby bitclust/packer.rb --output-dir="ruby-refm-2.0.0-dynamic-snapshot"

を実行すると ruby-refm-2.0.0-dynamic-snapshot.tar.bz2, ruby-refm-2.0.0-dynamic-snapshot.tar.gz, ruby-refm-2.0.0-dynamic-snapshot.zip が作成されます。

Windows以外の環境の場合はあらかじめexerbで作成したserver.exeとserver.exyを用意しておき、--output-dirに指定するディレクトリに入れておくとアーカイブに含めることができます。

リリースしたファイルの置き場所は http://www.ruby-lang.org/ja/man/archive/ と ftp.ruby-lang.org/pub/ruby/doc/ です。

最後に、git tag でタグを打っておきます。

chm版

まずbc-tochm.rbでdbからchm用の素材を作ります(ここまではOS非依存)。

$ ruby bc-tochm.rb -d ./db -o ./chm

次に、MicrosoftのHTML Help Workshopでchmファイルにまとめます(Windowsかwineが必要)。((-2013-08-29現在ではHTML Help Workshopは手に入らない-))

$ hhc.exe ./chm/refm.hhp

これで ./chm/refm.chm が作成できます。