"Si un trabajador quiere hacer bien su trabajo, primero debe afilar sus herramientas." - Confucio, "Las Analectas de Confucio. Lu Linggong"
Página delantera > Programación > Cómo publicar un paquete Golang

Cómo publicar un paquete Golang

Publicado el 2024-11-08
Navegar:923

Publicar un paquete es una buena manera de compartir tu herramienta con el mundo. Alguien puede importar el paquete y usarlo en su proyecto, y lograr la funcionalidad que usted ha creado. Es bastante fácil publicar un paquete de Golang en comparación con otros idiomas. Eso lo haremos en este blog. Recientemente publiqué mi paquete GenCLI. Puedes consultarlo aquí.

Para fines de demostración, tengo este proyecto CLI. Esta CLI impulsada por IA. Le proporciona respuestas a sus preguntas a través del terminal, construido con Cobra y Google Gemini API. Ahora bien, este proyecto es local y la única forma de ejecutarlo es ir a la raíz del proyecto y ejecutar main.go y luego usar subcomandos. Funcionará bien, pero el problema aquí es que no es confiable; cada vez, debemos ir a la raíz del proyecto y ejecutarlo; idealmente, debería ejecutarse desde cualquier lugar de la computadora, al igual que otras herramientas CLI. Además, no todo el mundo se molestará tanto en usarlo. Por eso es necesario, además de importante, publicar las herramientas.

Puede haber varias formas de nombrar su paquete, pero como lo alojaremos en GitHub, usaremos la forma de GitHub. Asegúrese de que en su archivo go.mod el nombre de su módulo sea la siguiente convención: github.com//, tal como se muestra a continuación.

Una cosa a tener en cuenta es que el módulo es una colección de paquetes. Generalmente decimos Publicar un módulo, no paquetes, pero para simplificarlo lo mantuvimos así.

module github.com/Pradumnasaraf/go-ai

go 1.22

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

)

Ahora, una vez que todo esté configurado, envía tu código a GitHub. Asegúrate de enviar el código al mismo nombre de usuario de GitHub y nombre de repositorio que mencionaste en el módulo.

Una vez que envíes el código a GitHub, es el momento de publicar tu paquete, pero antes de hacerlo, aquí tienes un par de prácticas recomendadas que debes seguir

  • Licencia: Tenga una licencia e intente imponerle una restricción mínima para que pueda usarse, modificarse y redistribuirse fácilmente.

  • Documentación: Podemos comentar en la parte superior del archivo del paquete para explicar la funcionalidad y golang toma esto como documentación general del paquete y lo muestra en la sección Documentación del paquete.

  • Etiquetas: El etiquetado es bueno cuando una persona tiene una versión particular del paquete; además, las versiones etiquetadas brindan resultados predecibles durante las compilaciones. Las etiquetas deben seguir a Semver. Además, intente lanzar versiones estables con 1.0.0 y superiores, esto les dará confianza a los desarrolladores.

Ahora, para publicar el paquete, diríjase a la URL https://pkg.go.dev/github.com/. En mi caso, sería https://pkg.go.dev/github.com/Pradumnasaraf/go-ai. Cuando visite, verá un botón de solicitud; haga clic en eso para solicitar que se agregue el paquete a pkg.go.dev. No lo haré porque no quiero publicar esta herramienta ya que era solo para una demostración.

How to Publish a Golang Package

Una vez que hayas terminado, después de unas horas, estará en el sitio web. Una vez que esté activo, puede descargar la CLI usando el comando go install:

go install 
go install github.com/Pradumnasaraf/go-ai@latest

Eso es todo por este blog. Me alegra que sigas leyendo y que también lo hayas hecho. ¡Gracias! A veces comparto consejos sobre Golang en Twitter. Puedes conectarte conmigo allí.

Declaración de liberación Este artículo se reproduce en: https://dev.to/pradumnasaraf/how-to-publish-a-golang-package-i12?1 Si hay alguna infracción, comuníquese con [email protected] para eliminarla.
Último tutorial Más>

Descargo de responsabilidad: Todos los recursos proporcionados provienen en parte de Internet. Si existe alguna infracción de sus derechos de autor u otros derechos e intereses, explique los motivos detallados y proporcione pruebas de los derechos de autor o derechos e intereses y luego envíelos al correo electrónico: [email protected]. Lo manejaremos por usted lo antes posible.

Copyright© 2022 湘ICP备2022001581号-3