So veröffentlichen Sie ein Golang-Paket

Die Veröffentlichung eines Pakets ist eine gute Möglichkeit, Ihr Tool mit der Welt zu teilen. Jemand kann das Paket importieren und in seinem Projekt verwenden und die von Ihnen erstellte Funktionalität nutzen. Im Vergleich zu anderen Sprachen ist es recht einfach, ein Golang-Paket zu veröffentlichen. Das werden wir in diesem Blog tun. Ich habe kürzlich mein GenCLI-Paket veröffentlicht, das Sie hier ansehen können.

Zu Demozwecken habe ich dieses CLI-Projekt. Diese KI-gestützte CLI. Über das Terminal, das mit Cobra und der Google Gemini API erstellt wurde, erhalten Sie Antworten auf Ihre Fragen. Jetzt ist dieses Projekt lokal und die einzige Möglichkeit, es auszuführen, besteht darin, zum Stammverzeichnis des Projekts zu gehen, main.go auszuführen und dann Unterbefehle zu verwenden. Es wird gut funktionieren, aber das Problem hierbei ist, dass dies nicht zuverlässig ist. Wir müssen jedes Mal zum Stammverzeichnis des Projekts gehen und es ausführen. Idealerweise sollte es von überall auf dem Computer ausgeführt werden, genau wie andere CLI-Tools. Außerdem wird sich nicht jeder so viel Mühe machen, es zu benutzen. Aus diesem Grund ist es sowohl notwendig als auch wichtig, die Tools zu veröffentlichen.

Es gibt mehrere Möglichkeiten, Ihr Paket zu benennen, aber da wir es auf GitHub hosten, verwenden wir die GitHub-Methode. Stellen Sie sicher, dass Ihr Modulname in Ihrer go.mod-Datei der folgenden Konvention entspricht: github.com//, genau wie unten.

Zu beachten ist, dass es sich bei dem Modul um eine Sammlung von Paketen handelt. Im Allgemeinen sagen wir: „Ein Modul veröffentlichen, nicht Pakete“, aber um es einfach zu halten, haben wir es so belassen.

module github.com/Pradumnasaraf/go-ai

go 1.22

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

)

Sobald alles eingestellt ist, übertragen Sie Ihren Code auf GitHub. Stellen Sie sicher, dass Sie den Code an denselben GitHub-Benutzernamen und Repo-Namen übertragen, den Sie im Modul angegeben haben.

Sobald Sie den Code auf GitHub übertragen haben, ist es an der Zeit, Ihr Paket zu veröffentlichen. Bevor Sie dies jedoch tun, finden Sie hier einige Best Practices, die Sie befolgen sollten

• Lizenz: Besitzen Sie eine Lizenz und versuchen Sie, diese mit minimalen Einschränkungen zu versehen, damit sie problemlos verwendet, geändert und weitergegeben werden kann.

• Dokumentation: Wir können oben in der Paketdatei einen Kommentar abgeben, um die Funktionalität zu erläutern. Golang nimmt dies als allgemeine Paketdokumentation und zeigt es im Abschnitt „Paketdokumentation“ an.

• Tags: Tagging ist gut, wenn eine Person über eine bestimmte Version des Pakets verfügt. Außerdem liefern getaggte Versionen während der Erstellung vorhersehbare Ergebnisse. Tags sollten Semver folgen. Versuchen Sie außerdem, stabile Versionen mit 1.0.0 und höher zu veröffentlichen, das gibt Entwicklern Vertrauen.

Um das Paket nun zu veröffentlichen, gehen Sie zur URL https://pkg.go.dev/github.com/. In meinem Fall wäre es https://pkg.go.dev/github.com/Pradumnasaraf/go-ai. Wenn Sie uns besuchen, sehen Sie eine Schaltfläche zum Anfordern; Klicken Sie darauf, um das Hinzufügen des Pakets zu pkg.go.dev anzufordern. Ich werde es nicht tun, weil ich dieses Tool nicht veröffentlichen möchte, da es nur für eine Demo gedacht war.

Sobald Sie fertig sind, wird es nach ein paar Stunden auf der Website verfügbar sein. Sobald es live ist, können Sie die CLI mit dem Befehl „go install“ herunterladen:

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

Das war's für diesen Blog. Ich freue mich, dass du noch liest und es auch geschafft hast. Danke schön! Manchmal teile ich Tipps zu Golang auf Twitter. Dort kannst du mit mir in Kontakt treten.

Das obige ist der detaillierte Inhalt vonSo veröffentlichen Sie ein Golang-Paket. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!