Golang パッケージを公開する方法

パッケージの公開は、ツールを世界と共有する良い方法です。誰かがパッケージをインポートして自分のプロジェクトで使用し、あなたが構築した機能を実現できます。他の言語と比べて、Golang パッケージを公開するのは非常に簡単です。それをこのブログでやっていきます。最近 GenCLI パッケージを公開しました。ここで確認できます。

デモの目的で、この CLI プロジェクトがあります。この AI を活用した CLI。 Cobra と Google Gemini API で構築されたターミナルを介して質問に対する回答が提供されます。このプロジェクトはローカルになり、これを実行する唯一の方法は、プロジェクトのルートに移動して main.go を実行し、サブコマンドを使用することです。これは問題なく動作しますが、ここでの問題は、これが信頼できないことです。毎回、プロジェクトのルートに移動して実行する必要があります。理想的には、他の CLI ツールと同様に、コンピューター上のどこからでも実行できるはずです。さらに、誰もがこれを使用するためにこれほど面倒なことをするわけではありません。したがって、ツールを公開することが必要であり、重要である理由もここにあります。

パッケージに名前を付ける方法は複数ありますが、GitHub でホストするため、GitHub の方法を使用します。 go.mod ファイル内でモジュール名が、以下のように github.com// という規則になっていることを確認してください。

注意すべき点の 1 つは、モジュールがパッケージのコレクションであるということです。一般に、パッケージではなくモジュールを公開すると言いますが、わかりやすくするためにそのようにしました。

module github.com/Pradumnasaraf/go-ai

go 1.22

require (
....
....
....

)

すべての設定が完了したら、コードを GitHub にプッシュします。必ず、モジュールで言及したのと同じ GitHub ユーザー名とリポジ名にコードをプッシュしてください。

コードを GitHub にプッシュしたら、パッケージを公開します。その前に、従うべきベスト プラクティスをいくつか示します。

• ライセンス: ライセンスを取得し、簡単に使用、変更、再配布できるように、ライセンスに最小限の制限を設けるようにしてください。

• ドキュメント: パッケージ ファイルの先頭に機能を説明するコメントを付けることができ、golang はこれを一般的なパッケージ ドキュメントとして受け取り、パッケージ ドキュメント セクションの下に表示します。

• タグ: タグ付けは、特定のバージョンのパッケージを持っている場合に適しています。また、タグ付けされたバージョンは、ビルド中に予測可能な結果を​​もたらします。タグは Semver に従う必要があります。また、1.0.0 以降の安定したバージョンをリリースするようにしてください。これにより、開発者は自信を持ちます。

次に、URL https://pkg.go.dev/github.com/ にアクセスしてパッケージを公開します。私の場合は、https://pkg.go.dev/github.com/Pradumnasaraf/go-ai になります。アクセスするとリクエストボタンが表示されます。それをクリックして、pkg.go.dev へのパッケージの追加をリクエストします。このツールはデモのためだけに公開したくないため、公開しません。

完了したら、数時間後にウェブサイトに公開されます。公開されたら、 go install コマンドを使用して CLI をダウンロードできます。

go install <repo-url>
go install github.com/Pradumnasaraf/go-ai@latest

このブログはここまでです。あなたもまだ読んでいて、それを作ってくれて嬉しいです。ありがとう！ Twitter で Golang に関するヒントを共有することがあります。そこで私とつながることができます。

以上がGolang パッケージを公開する方法の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。