godoc.org への掲載方法を調べた
毎週のGolanag Cafeの成果を試してみるべく、先日go-pop3なるパッケージを公開してみました。
内容は大変シンプルでPOP3でメールをダウンロードするだけです。以前C#で作成したものを焼き直し+αしただけのものです。
Go言語にはGoDocというGithubを始めとする公開リポジトリに登録されているパッケージを検索できるサービスがあります。
ここに私の作成したパッケージも掲載してほしい、というのが始まりです。
GoDoc crawls package imports to automatically find new packages.
とAbout - GoDoc書いてあったのでいつ掲載されるかと待ち続けていたのですが、一向に掲載されません。
ドキュメントの書き方がまずいのか色々確認してみてもおかしなところもありません。
テストが足りないのかと思いましたが必要最低限のものはあります。(すいません、カバレッジは100%じゃないです)
そこで、再度About - GoDocを読み返してみました。するとやっぱり書いてありました。
To add a package to GoDoc, search for the package by import path.
「掲載するにはインポートパスを入力して検索して」と。英語力のなさを痛感しました。
その通りにやってみました。
まずは検索のところで「github.com/taknb2nch/go-pop3」と入力して検索。
これだけで登録されたようです。
本当に登録されたかpop3というキーワードで検索してみます。
ついに登録されました!
Githubに更新した内容をすぐに反映したい場合はページ下部の「Refresh now」をクリックします。
GoDocから削除するにはgithubのリポジトリから削除するか、削除したいパッケージのインポートパスを記載してinfo@godoc.orgまでメールを送ればいいそうです。