オフトゥン大好き

惰眠系プログラマの作業ログで( ˘ω˘ ) スヤァ…

CPANにPerlモジュールを公開するまでの手順

CPANにAuthor登録してモジュールを公開したので、やったことを書いていく。個人的な覚書の側面が強いのであまりまとまってないかも。

ちゃんとした手順が知りたい人はQiitaとかで記事を探したほうがいいと思う。

CPAN Author登録してもらう

モジュールを公開するにはPAUSE(Perl programming Authors Upload Server)というのに登録しなければいけない。

モジュールができてからでもいいけど、npmとかRubyGemsとは違って登録作業はCPANの中の人が手動でやってるっぽいので長くて1日くらいかかる。まだ、モジュールができてない状態でもこれからどんなモジュールを公開していきたいかという抱負だけで登録してもらえるので申請だけ出しておいたほうがよい。

ツールを揃える

perlplenv経由でインストールされている前提で書いている。揃えるべきツールは以下の3つ。

Name Description
cpanm Perlモジュールインストーラ
Carton モジュールプロジェクト下に依存モジュールをインストールするツール
Minilla モジュールの雛形を作るオーサリングツール
インストール手順
  1. plenvにはinstall-cpanmというコマンドが付属しているので、これを使ってまずはcpanmをインストールする
  2. Cartonをインストールする
  3. Minillaをインストールする
$ plenv install-cpanm # (1
$ cpanm carton        # (2
$ cpanm Minilla       # (3

モジュールの雛形を作る

Minillaでモジュールの雛形を作る。

$ minil new <module name>

モジュール名はハイフンが入るとそこでネームスペースが切られる。例えば、saiko-no-moduleとすると生成後の雛形はlib/saiko/no/module.pmという構造を持ち、公開後のモジュール名はSaiko::No::Moduleという名前になる。まあ、こんな名前をつけてはいけない。基本的にモジュール名はすでに公開されてるものを参考にしてつけるのが良い。迷ったらフォーラムで質問してもいい。Perl Mongerは優しい。

コードとモジュール情報を書く

メタ情報はMETA.jsonに書いてあるが、これはMinillaが自動で生成するので直接いじらない。Minillaはコードやcpanfileminil.tomlから必要な情報を集めてこれを出力する。README.mdもコードのpodドキュメントから生成されるのでいじらない。

テストを走らせるには次のようにする。

$ minil test

ただ、このコマンドではgitの管理下に追加されていないテストは実行されないので、.tファイルを追加したらまずgit addする。

公開する

PAUSEに登録され、コードを書いて、テストが通ったらいよいよ公開する。 公開にはPAUSEのサイトにtar.gzをアップロードするのがトラディショナルなやり方。でも、Minillaを使えばコマンドラインから公開できる。

$ minil release

その他

モジュールを公開したら、CPANのテストサーバからメールが来る。これはアップロードされたモジュールがテストを通過するかどうかを色々なプラットフォームでチェックしてくれているらしい。Travis CIとかCircle CIとかでアップロードする前にテストすることが望ましいけど、環境がubuntuのみだったりするのでBSDなんかでもテストしてくれるのはありがたい。落ちたテストレポートへのリンクが添付されているので修正に役立つ。

関連記事

nukosuke.hatenablog.jp