Ruby

[Ruby] 自作のgemを作成して公開するまでの手順まとめ

Rubyのライブラリを作成して公開するまでがかなりやり易かったので手順をまとめます。 ## 手順 1. コマンドからテンプレートを作成する 1. コマンドの中身を作成していく 1. RubyGemsに公開する ## コマンドからテンプレートを作成する 以下のコマンドでテンプレートが作成できます。 ``` $ bundle gem {bundle name} ``` コマンドを実行すると、使うテストの種類や、コミット時にGithub Actionを実行するかどうか聞かれます。 Github Actionは有効にしておくとコミットしたときにテストが走るようになるので便利です。 バンドル名にハイフン`-`が入ると、フォルダ階層が作成されるので、嫌な場合は含めないようにします。 後から自分で設定ファイルなどを編集して階層を無くす事も可能です。 (その場合もテストがあると、自信を持って進められます) ## コマンドの中身を作成していく 以下のフォルダにコードを追加していきます。 | フォルダ,ファイル | 説明 | |-----------------------|------------------------------| | lib | ライブラリのコードを記載する | | test | テストを記載する | | {bundle name}.gemspec | ライブラリの設定ファイル | 以下のコマンドでテストなどを実施します。 ### テスト ``` $ rake test ``` ### シンタックスチェック, 修正 ``` $ rubocup $ rubocup -A # 構文を修正する ``` ## RubyGemsに公開する RubyGemsに公開するために、アカウントを作成しておきます。 ### 手元で確認する 以下のコマンドで手元のマシンにインストールして確認できます。 ``` $ rake build # pkg/ にgemが作成される。 $ gem install pkg/xxxx.gem # 作成したgemをインストールする ``` ### RubyGemsに公開する ``` $ bundle exec rake release ``` githubのmainブランチにタグが作成されて、RubyGemsに公開されます。 ## 参考URL - [ondotori-ruby-client](https://github.com/k28/ondotori-ruby-client) - [Githubが公開しているRubyのWebAPIクライアント](https://github.com/octokit/octokit.rb/blob/4-stable/lib/octokit.rb) - [【Ruby】gemの作り方から公開まで](https://qiita.com/9sako6/items/72994b8b1c00af4e61fe) - [作ったgemをリリースするまで](https://qiita.com/kyohei8/items/b292f727e213ed7db9d7)