Как принято шарить *.proto файлы между командами?

Question

[superkolya]

Допустим есть сервис users, который работает по protobuf. Допустим есть 2 клиента этого сервиса на Go и nodejs над которыми трудятся соответственно 2 разные команды. Как принято шарить *.proto файлы для генерации клиентов между другими командами?

Comments

[Василий Банников]

Первое что в голову приходит - через git submodule, но я никогда не работал с grpc в такой ситуации, так что очень интересно, как это делают другие.

[superkolya]

Василий Банников, ну придумать можно много разных вариантов, интересует именно практика кто и как сейчас это делает

[Василий Банников]

superkolya, на реддите увидел такую штуку: https://buf.build/
По сути пакетный менеджер для proto файлов.
Много кто действительно использует сабмодули, либо какие-то надстройки над ними.
Ещё способ - сделать для всех команд монорепозиторий, но тогда придётся мучаться с ним

Answer 1

[Михаил]

В дополнение к ответу Василий Банников
Сложить файлы *.proto в отдельный репозиторий и настроить CI чтобы он по этим файлам генерил артефакты для Go и nodejs (и складывал их в репозиторий артефактов, для npm и что там у го в качестве менеджера пакетов). А в проектах добавить зависимости от этих артефактов и, таким образом, избавиться от необходимости иметь сами *.proto файлы в проектах.

Comments

[Василий Банников]

только для бэкенда такой способ не прокатит. тк из proto файлов генерится код, который потом надо ещё руками дописать.

[Михаил]

Василий Банников, с протобуфом дела не имел, так что может быть и не получится, но вот с openapi файлами в нашем проекте такое прокатывает на "отлично"

[Василий Банников]

Михаил, возможно я просто что-то не так понял

[Василий Банников]

agagaheash ashaherya4wr, извиняюсь. я перепутал. Был уверен, что там генерится код, который самому дописывать надо, а на самом деле в шарпе генерится набор из абстрактных классов, от которых надо наследоваться и реализовывать методы.
Так что способ с распространением библиотек должен работать.

Answer 2

[Василий Банников]

Из того что я нашёл:
1. git submodule (но будут проблемы с синхронизацией, тк автоматически они не обновляются)
2. Какие-то скрипты поверх git submodule, которые будут решать их проблемы. (в комментах дали ссылку на такую штуку: https://github.com/protop-io/protop, но я бы не стал её использовать)
3. Какие-то сторонние решения (https://buf.build/). Можно загуглить как-нибудь типа "protobuf package manager"
4. монорепозиторий (monorepo), чтобы избавиться от сабмодулей на корню.

Answer 3

[CentariumV]

По поводу стороннего решения
https://buf.build - блокирует по ip Россию

ping-admin.com