Handbook

# Gitlab

# Создание нового проекта в Gitlab

  1. Выбор группы:

    • Для инфраструктурных проектов используйте группу "/infra". В остальных случаях "/apliteni".
    • Обратите внимание, что проект будет доступен для всех участников выбранной группы.

  2. Выбор подгруппы:

    • Если ожидается несколько репозиториев/сервисов, то сразу заведите подгруппу по имени проекта. Например, "apliteni/gdbc". У проектов на go есть ряд проблем при использовании подгрупп в имени пакета, здесь решение https://gitlab.com/gitlab-org/gitlab-ce/issues/30785#note_132378592

  3. Выбор имени проекта:

    • Для разделения слов в имени, используйте знак - (минус). Пример, auth-api-service. Если у проекта есть домен, можно назвать по имени домена api.domain.com

  4. Создайте README.md с описанием проекта на русском языке.

# Версионирование проекта

В каждом проекте заводится файл с номером версии. Это может version.php, version.go или version.ts. Номер версии выставляем согласно соглашению SemVer 2.0.

+------- Мажорная версия, содержащая крупные изменения продукта
| +----- Минорная версия, небольшие изменения, небольшие фичи
| | +--- Патчи
| | | +- Критические фиксы (hot-fixes)
x.x.x.x

В проектах, где не требуется версионирование и деплои частые, используем Short SHA коммита.

# Получение публичных ключей

Публичный ключ любого пользователя запрашивается по адресам формата:

https://gitlab.apliteni.com/USERNAME.keys

# Встраивание общих репозиториев

Для встраивания общих репозиториев считается оптимальным git subtree.

Хороший tutorial

При первом клонировании репозитория или добавлении новых источников subtree Для добавления репозитория в папку .git разово нужно выполнить:

git remote add <имя источника> <git url источника>

При добавлении нового subtree (Если нужно просто пользоваться проектом этот пункт не нужен) Если нужно добавить новый источник subtree в папку выполнить 1 раз:

git subtree add --prefix=<папка> <имя источника> <ветка>

В частности при добавлении migrator была использована комманда:

git subtree add --prefix=some_folder some_repo master

После коммита для пуша в репозиторий migrator надо сделать

git subtree push --prefix=<папка> <имя источника> <ветка>

Т.е. например:

git subtree push --prefix=some_folder some_repo master

Чтобы подтянуть свежие изменения соответственно надо сделать

git subtree pull --prefix=<папка> <имя источника> <ветка>

← Gitlab CI/CD →