Comment publier un package Golang

Publier un package est un bon moyen de partager votre outil avec le monde. Quelqu'un peut importer le package et l'utiliser dans son projet, et obtenir les fonctionnalités que vous avez créées. Il est assez facile de publier un package Golang par rapport à d'autres langages. Nous le ferons dans ce blog. J'ai récemment publié mon package GenCLI, vous pouvez le consulter ici.

À des fins de démonstration, j'ai ce projet CLI. Cette CLI alimentée par l'IA. Il vous apporte les réponses à vos questions via le terminal, construit avec l'API Cobra et Google Gemini. Maintenant, ce projet est local, et la seule façon de l'exécuter est d'aller à la racine du projet et d'exécuter main.go, puis d'utiliser les sous-commandes. Cela fonctionnera bien, mais le problème ici est que ce n'est pas fiable, à chaque fois, nous devons accéder à la racine du projet et l'exécuter. Idéalement, il devrait s'exécuter depuis n'importe où sur l'ordinateur, tout comme les autres outils CLI. De plus, tout le monde n’aura pas autant de mal à l’utiliser. C'est pourquoi il est nécessaire et important de publier les outils.

Il peut y avoir plusieurs façons de nommer votre package, mais comme nous l'hébergerons sur GitHub, nous utiliserons la méthode GitHub. Assurez-vous que dans votre fichier go.mod, le nom de votre module respecte la convention suivante - github.com//, comme ci-dessous.

Une chose à noter est que le module est une collection de packages. Nous disons généralement publier un module et non des packages, mais pour rester simple, nous l'avons gardé ainsi.

module github.com/Pradumnasaraf/go-ai

go 1.22

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

)

Maintenant, une fois que tout est défini, envoyez votre code vers GitHub. Assurez-vous de transmettre le code au même nom d'utilisateur GitHub et au même nom de dépôt que vous avez mentionnés dans le module.

Une fois que vous avez transmis le code à GitHub, il est maintenant temps de publier votre package, mais avant de le faire, voici quelques bonnes pratiques à suivre

• Licence : Ayez une licence et essayez de lui imposer une restriction minimale afin qu'elle puisse facilement être utilisée, modifiée et redistribuée.

• Documentation : Nous pouvons commenter le haut du fichier du package pour expliquer la fonctionnalité et Golang le prend comme documentation générale du package et l'affiche dans la section Documentation du package.

• Balises : Le balisage est efficace lorsqu'une personne possède une version particulière du package. Les versions balisées donnent également des résultats prévisibles lors des builds. Les balises doivent suivre Semver. Essayez également de publier des versions stables avec la version 1.0.0 et supérieure, cela donne confiance aux développeurs.

Maintenant, pour publier le package, rendez-vous sur l'URL https://pkg.go.dev/github.com/. Dans mon cas, ce serait https://pkg.go.dev/github.com/Pradumnasaraf/go-ai. Lors de votre visite, vous verrez un bouton de demande ; cliquez dessus pour demander l'ajout du package à pkg.go.dev. Je ne le ferai pas car je ne souhaite pas publier cet outil car c'était juste pour une démo.

Une fois que vous aurez terminé, après quelques heures, ce sera sur le site. Une fois qu'elle est en ligne, vous pouvez télécharger la CLI en utilisant la commande go install :

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

C'est tout pour ce blog. Je suis heureux que vous lisiez encore et que vous l'ayez fait aussi. Merci! Je partage parfois des astuces sur Golang sur Twitter. Vous pouvez me contacter là-bas.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!