Система управления версиями
Общие сведения
Можно использовать хранилище 1С, git или другие системы для управления версиями.
Соглашение о коммитах
Все помещения изменений должны быть осмысленно описаны, главным ориентиром является популярное соглашение о коммитах Conventional Commits.
Для соблюдения требований при использовании хранилища 1С, требуется при помещении измененных объектов в соответствующем диалоге конфигуратора указывать в комментарии краткое описание характера изменений с точки зрения пользователя. Это в дальнейшем облегчит сборку общего описания изменений к релизу.
Чтобы контролировать шаблон коммитов в хранилище 1С используется служба OproxyDaemon, ссылка на проект Oproxy.
Шаблон коммита:
--GitSyncAuthor [Необязательное имя пользователя хранилища]
[Тип](необязательный контекст): [Короткое описание] (номер задачи)
[необязательное тело]
[необязательная(ые) сноска(и)]
Пример коммита:
--GitSyncAuthor ivanov
fix: Запрет редактирования реквизита (#COEF1C-4663)
Добавлены роли "...";
Добавлены элементы на форме "...".
Примечание: при использовании методологии gitflow, в тексте коммита не указывается номер задачи.
Чтобы изменения автоматически включались в список изменений (CHANGELOG.md), требуется выбирать правильно [Group]:
| Group | № | Full name | Description |
|---|---|---|---|
| feat | 0 | 🚀 Features | Новая функция (Добавили новый документ, обработку, отчет, изменили команду и так далее) |
| fix | 1 | 🐛 Bug Fixes | Исправление багов/ошибок (Ошибка в ЖР, баг от заказчика, замечание от тестировщика) |
| doc | 2 | 📚 Documentation | Изменяется только документация (Заполнение справки в конфигураторе 1С или изменения в каталоге "doc" в проекте в репозитории git) |
| perf | 3 | ⚡ Performance | Изменение кода, повышающее производительность (Ускорили запрос или убрали запросы из цикла, добавили блокировки и так далее) |
| refactor | 4 | 🚜 Refactor | Рефакторинг кода (Изменение кода, которое не исправляет ошибку и не добавляет функций) |
| style | 5 | 🎨 Styling | Изменения не влияющие на смысл кода (пробелы, форматирование, отсутствие точки с запятой...) |
| test | 6 | 🧪 Testing | Добавление недостающих тестов или исправление существующих тестов |
| chore(release): version x.x.x.x | 0 | 📌 New release of configuration | Выпуск релиза |
| chore(release): prepare for x.x.x.x | skip = true | Подготовка к релизу | |
| chore(deps.*) | skip = true | Служебные изменения | |
| chore(pr) | skip = true | Служебные изменения | |
| chore(pull) | skip = true | Служебные изменения | |
| chore | 7 | ⚙️ Miscellaneous Tasks | Другие изменения, не влияющие на исходный код или тесты |
| ci | 7 | ⚙️ Miscellaneous Tasks | Настройка Continue Integration (Pipeline) |
| body = ".*security" | 8 | 🛡️ Security | Исправление безопасности |
| revert | 9 | ◀️ Revert | Отмена прошлых изменений (Повторяем текст комментария коммита, который отменяем) |
Таблица приведена только в качестве информации, актуальную таблицу смотрите в каждом про екте на корпоративном сервере системы управления версиями, в файле cliff.toml (сайт проекта)
Рекомендации
Описание изменений необходимо делать при каждом помещении изменений;
Не рекомендуется накапливать мало связанные между собой изменения до помещения их. Версии должны быть максимально "атомарные";
Для сбора отчета по изменениям можно воспользоваться стандартной функцией конфигуратора "отчет по версиям хранилища";
Как подключить хранилище 1С в конфигураторе к ИБ
Откройте нужную информационную базу в режиме конфигуратора. Для подключения хранилища 1С в конфигураторе к информационной базе (ИБ), необходимо выполнить следующие шаги:
Основная конфигурация
Вот пошаговая инструкция по подключению конфигурации к хранилищу 1С:
- В активном окне конфигурации выберите пункт "Действия" → "Конфигурация" → "Хранилище конфигурации" → "Подключиться к хранилищу..."
- В открывшемся окне укажите:
- Путь к хранилищу конфигурации (локальный или сетевой)
- Имя пользователя хранилища
- Пароль пользователя хранилища
- Нажмите кнопку "OK"
- Если подключение выполняется впервые, система предложит загрузить конфигурацию из хранилища. Согласитесь с этим действием.
- Дождитесь окончания процесса загрузки конфигурации из хранилища
Расширения конфигурации
Вот пошаговая инструкция по подключению расширения к хранилищу 1С:
- В главном меню выберите пункт "Конфигурация" → "Расширения"
- Выберите нужное расширение и откройте его двойным щелчком
- Повторите пункты описанные в подключении хранилища к основной конфигурации
- Повторите с каждым расширением
Получить из хранилища
- В активном окне конфигурации выберите пункт "Действия" → "Конфигурация" → "Хранилище конфигурации" → "Обновить из хранилища"
- Повторите для всех расширений
Создание пользователей
Имя пользователя в хранилище должно соответствовать имени базы. Например, если подключение к базе Srvr="rnd-1c8-srv1";Ref="dev-enterprice20-ivanov"; то имя пользователя в хранилище будет dev-enterprice20-ivanov.
Имя базы должно соответствовать шаблону Окружение_Конфигура ция_Фамилия.
Важные замечания
- Перед подключением убедитесь, что у вас есть права на работу с хранилищем
- Рекомендуется сделать резервную копию информационной базы перед подключением к хранилищу
- Если конфигурация базы подключена к хранилищу под неизвестным пользователем, то сначала выполните отключение
После успешного подключения к хранилищу в меню "Конфигурация" → "Хранилище конфигурации" станут доступны дополнительные команды для работы с хранилищем (захват объектов, помещение изменений и т.д.).