如何發布 Golang 包

發布包是與世界分享您的工具的好方法。有人可以匯入該套件並在他們的專案中使用它，並實現您建立的功能。與其他語言相比，發布 Golang 套件非常容易。我們將在這個部落格中做到這一點。我最近發布了我的 GenCLI 包，您可以在這裡查看。

出於演示目的，我有這個 CLI 專案。這個由人工智慧驅動的 CLI。它透過使用 Cobra 和 Google Gemini API 構建的終端為您提供問題的答案。現在這個專案是本地的，運行它的唯一方法是轉到專案的根目錄並執行 go run main.go，然後使用子命令。它會運作得很好，但這裡的問題是這並不可靠，每次我們都需要轉到專案根目錄並運行它，理想情況下，它應該從電腦上的任何位置運行，就像其他CLI 工具一樣。另外，並不是每個人都會這麼麻煩地使用它。所以，這就是為什麼發布這些工具是必要的，也是重要的。

可以採用多種方式來命名您的套件，但由於我們將在 GitHub 上託管它，因此我們將使用 GitHub 方式。確保您的 go.mod 檔案中的模組名稱符合以下約定 - github.com//，如下所示。

要注意的一點是，模組是 Packages 的集合。我們通常說發布模組而不是包，但為了簡單起見，我們保持這種方式。

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中文網其他相關文章！