«Если рабочий хочет хорошо выполнять свою работу, он должен сначала заточить свои инструменты» — Конфуций, «Аналитики Конфуция. Лу Лингун»
титульная страница > программирование > Как опубликовать пакет Golang

Как опубликовать пакет Golang

Опубликовано 8 ноября 2024 г.
Просматривать:448

Публикация пакета — хороший способ поделиться своим инструментом со всем миром. Кто-то может импортировать пакет и использовать его в своем проекте и реализовать созданную вами функциональность. Опубликовать пакет Golang довольно легко по сравнению с другими языками. Мы сделаем это в этом блоге. Недавно я опубликовал свой пакет GenCLI, вы можете ознакомиться с ним здесь.

Для демонстрационных целей у меня есть этот проект CLI. Это интерфейс командной строки на базе искусственного интеллекта. Он предоставляет вам ответы на ваши вопросы через терминал, созданный с помощью Cobra и Google Gemini API. Теперь этот проект является локальным, и единственный способ запустить его — перейти в корень проекта и запустить main.go, а затем использовать подкоманды. Он будет работать нормально, но проблема в том, что это ненадежно, каждый раз нам нужно заходить в корень проекта и запускать его, в идеале он должен запускаться из любого места на компьютере, как и другие инструменты CLI. Плюс, не каждый будет прикладывать столько хлопот, чтобы его использовать. Вот почему необходимо и важно публиковать инструменты.

Может быть несколько способов назвать ваш пакет, но поскольку мы будем размещать его на GitHub, мы будем использовать способ GitHub. Убедитесь, что в файле go.mod имя вашего модуля соответствует следующему соглашению — github.com//, как показано ниже.

Следует отметить, что модуль представляет собой набор пакетов. Обычно мы говорим «Публикация модуля, а не пакетов», но для простоты мы оставили именно так.

module github.com/Pradumnasaraf/go-ai

go 1.22

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

)

Теперь, когда все настроено, отправьте свой код на GitHub. Убедитесь, что вы отправили код на то же имя пользователя GitHub и имя репозитория, которые вы указали в модуле.

После того, как вы отправите код на GitHub, пришло время опубликовать ваш пакет, но прежде чем вы это сделаете, вот несколько рекомендаций, которым вам следует следовать

  • Лицензия: Имейте лицензию и постарайтесь наложить на нее минимальные ограничения, чтобы ее можно было легко использовать, изменять и распространять.

  • Документация: Мы можем прокомментировать верхнюю часть файла пакета, чтобы объяснить функциональность, и golang воспринимает это как общую документацию пакета и отображает ее в разделе «Документация пакета».

  • Теги: Маркировка хороша, когда у человека есть определенная версия пакета, также версии с тегами дают предсказуемые результаты во время сборки. Теги должны следовать за Семвером. Также старайтесь выпускать стабильные версии 1.0.0 и выше, это придаёт уверенности разработчикам.

Теперь опубликуйте пакет по URL-адресу https://pkg.go.dev/github.com/. В моем случае это будет https://pkg.go.dev/github.com/Pradumnasaraf/go-ai. При посещении вы увидите кнопку запроса; нажмите на нее, чтобы запросить добавление пакета в pkg.go.dev. Я не буду этого делать, потому что не хочу публиковать этот инструмент, поскольку он предназначен только для демонстрации.

How to Publish a Golang Package

Как только вы закончите, через несколько часов он появится на сайте. Как только он будет опубликован, вы сможете загрузить CLI с помощью команды go install:

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

Вот и все для этого блога. Я рад, что вы все еще читаете и тоже это сделали. Спасибо! Иногда я делюсь советами по Golang в Твиттере. Вы можете связаться со мной там.

Заявление о выпуске Эта статья воспроизведена по адресу: https://dev.to/pradumnasaraf/how-to-publish-a-golang-package-i12?1. Если есть какие-либо нарушения, свяжитесь с [email protected], чтобы удалить ее.
Последний учебник Более>

Изучайте китайский

Отказ от ответственности: Все предоставленные ресурсы частично взяты из Интернета. В случае нарушения ваших авторских прав или других прав и интересов, пожалуйста, объясните подробные причины и предоставьте доказательства авторских прав или прав и интересов, а затем отправьте их по электронной почте: [email protected]. Мы сделаем это за вас как можно скорее.

Copyright© 2022 湘ICP备2022001581号-3