Дополнительные средства разработки
25.11.2020

1С:ГитКонвертер

Конфигурация предназначена для односторонней синхронизации хранилища конфигурации "1С:Предприятия" с репозиторием Git и последующим переходом на разработку в 1C:Enterprise Development Tools (1C:EDT) с сохранением истории.

Основные возможности

• Конвертирование существующего хранилища конфигурации "1С:Предприятия" в репозиторий Git в формате 1C:EDT.
• Обновлять изменения из хранилища "1С:Предприятия" в репозиторий Git.
• Параллелизировать загрузку истории хранилища из копий хранилища.
• Ограничение нагрузки на сервер с помощью очередей.
• Возможно "сращивать" историю в Git, если хранилище конфигураций "1С:Предприятия" обрезалось или начиналось заново.
• Создание корректной истории переименования объектов метаданных (см. Как это работает).

• Выгружать только изменения конфигурации. 

  Доступно для Платформы 8.3.10 и выше, для версий ниже 8.3.15 требуется использовать "очереди".

• Создание сквозной история изменений для "хранилищ исправительных версий" если вы используете Технологию разветвленной. разработки конфигураций (https://its.1c.ru/db/v8std#content:709:hdoc) или аналогичный процесс - хранилище версии можно загружать в "ветку" Git, получив сквозную историю в ветке.
• Возможность автоматически указывать Git теги при изменении версии конфигурации.
• Поддержка конвертации разных хранилищ в разные ветки одного репозитория на различных версия Платформы и различных версиях 1C:EDT.

• Поддержка конвертации хранилищ расширений конфигураций. Возможность связи с базовым проектом 1С:ГитКонвертера или независимо.

Необходимые компоненты

• Конфигурацию можно запустить, используя 1C:Enterprise Development Tools 2020.6 (https://releases.1c.ru/project/DevelopmentTools10)
• Платформа "1С:Предприятие" версии 8.3.12 и выше (https://releases.1c.ru/project/Platform83)
• СУБД, поддерживаемая "1С:Предприятием"
• OS Windows 7 или выше, ОС Linux и macOS - в бета-режиме.

Начальная настройка

Параметры настройки и сценарии применения в официальном репозитории компании 1С на GitHub https://github.com/1C-Company/GitConverter/wiki

Настройка базы ГитКонвертера

1. Разместите базу ГитКонвертера на сервере "1С:Предприятия". Работа в файловом режиме может быть использована только в демонстрационных целях.
2. Заполните константу "Путь к версиям платформы на сервере", где располагаются файлы Конфигуратора 1cv8(.exe) в формате: C:\Program files (x86)\1cv8\%ВерсияПлатформы%\bin , где в параметр %ВерсияПлатформы% - будет подставлена текущая версия хранилища из настроек.
3. Для ограничения производительности можно включить константу "Использовать очереди выполнения" - количеством очередей можно балансировать нагрузку на сервер.

Настройка сервера "1С:Предприятия"

Для информационной базы ГитКонвертера на сервере "1С:Предприятия" рекомендуется настроить удаление, перенос в архив или полностью отключить журнал регистрации, т.к. интенсивность событий в информационной базе может быть очень высокой, а ценность истории журнала регистрации за прошлые периоды - низкая.

Для легкого удаления и архивирования журнала регистрации можно переключить его формат на старый режим. Для этого необходимо в каталог журнала регистрации информационной базы скопировать пустой файл с именем: 1Cv8.lgf.
Для больших проектов рекомендуется  выполнить такую настройку (удаление/резервное копирование файлов журнала регистрации).

Также рекомендуется переключить регистрацию событий - только ошибки. Для этого следует выбрать команду в Конфигураторе  Администрирование - Настройка журнала регистрации... = Регистрировать ошибки и в открывшемся диалоге установить минимально необходимую вам периодичность.

Настройка конвертации хранилища "1С:Предприятия"

Рекомендуется использовать сервер хранилищ конфигураций "1С:Предприятия".

Для оптимальной работы сервера хранилищ настройте Размер глобального кэша в "Администрировании" в 1,5-2 раза больше количества параллельных потоков (если используются "копии хранилища") получения версий * размер одной версии, Мб.

Параметры конвертации

• Укажите адрес хранилища. При использовании сервера хранилища рекомендуется настроить в администрировании хранилища параметр "Глобальный кэш версий конфигурации", чтобы количество кэшированных версий было больше параллельно получаемых версий.
• Укажите версию платформы, рекомендуется использовать 8.3.15.2107 и выше.
• Укажите начальную версию в хранилище конфигураций, если текущее хранилище было обрезано и первая версия больше 1.
• Если указана версия окончания - не будет выполняться запрос новых версий.
• Укажите расписание запусков.
• Укажите Каталог выгрузки версий, в котором будут создаваться временные каталоги с номерами версий и выгрузкой данных.
• Желательно ограничить количество подготавливаемых (выгружаемых) версий - рекомендуется установить значение исходя из Размер базы с версией + Размер выгрузки в xml и размера жесткого диска.
• Укажите Минимальное количество метаданных - число файлов и каталогов выгрузки в xml - необходимо для контроля, что все файлы выгружены. Рекомендуется устанавливать 90-95% от текущей версии, чтобы учесть возможность удаления метаданных (т.е. сокращения количества файлов).
• Не рекомендуется устанавливать Удаление конфигураций поставщиков, если планируется загружать конфигурацию из файлов и обновлять конфигурации поставщиков. Опция позволяет оптимизировать размер хранилища Git и не хранить объемные файлы *.cf.
• Установите Удалять временные данные версии после коммита - рекомендуется на реальных проектах.
  Выгружать изменения - позволяет на Платформе версии 8.3.10 и выше выгружать только изменения. Доступно при использовании "Очередей".
• Локальный каталог Git рекомендуется указывать на одном логическом диске с Каталогом выгрузки версий - будет использовано перемещение версий возможностями ОС, иначе будет выполняться копирование.
• Каталог выгрузки в репозитории - относительный путь к каталогу выгрузки внутри репозитория. Рекомендуется указывать имя проекта для будущей совместимости с рабочим пространством 1C:EDT или оставить пустым.
• Установите флаг Выполнять коммиты для выполнения коммитов. Отключение может быть необходимо с целью временно приостановить работу конвертера.
• Установите флаг Обрабатывать все очереди, если используются очереди в ИБ.
• Нажмите кнопку "Создать гит репозиторий" перед конвертацией - команда выполняет инициализацию репозитория и начальную настройку, специфичную для конфигураций "1С:Предприятия".

Дополнительная настройка репозитория Git

По умолчанию создается файл исключений .gitignore, в который добавляются файлы DumpFilesIndex.txt и ConfigDumpInfo.xml - не требуемые для работы с исходными файлами конфигурации "1С:Предприятия".

Если репозиторий был создан с помощью кнопки в карточке хранилища, в локальный конфиг репозитория добавляются настройки для более комфортной работы:

git config --local core.quotepath false
git config --local gui.encoding utf-8
git config --local i18n.commitEncoding utf-8
git config --local diff.renameLimit 1
git config --local diff.renames false

Символы окончания строк

Если разработчики, работающие с репозиторием, используют разные операционные системы (Microsoft Windows, Linux, macOS), нужно настроить конвертацию символов окончания строк при чтении из репозитория. Следующие команды настраивают Git таким образом, что в рабочей копии разработчика будут использоваться "родные" для его операционной системы символы, а в репозитории всегда будет использоваться LF.


Для операционной системы Microsoft Windows:

git config --global core.autocrlf true
git config --global core.safecrlf true

Для операционных систем Linux и macOS:

git config --global core.autocrlf input
git config --global core.safecrlf true

Подробнее о назначении этих параметров вы можете прочитать в документации Git на английском языке git config core.safecrlf (http://git-scm.com/docs/git-config#git-config-coresafecrlf) и git config core.autocrlf (http://git-scm.com/docs/git-config#git-config-coreautocrlf).

Git LFS

Для увеличения быстродействия репозитория Git можно использовать расширение git lfs (https://git-lfs.github.com).

Если используется сервер репозиториев Git, необходимо убедиться, что он поддерживает это расширение и включить настройки для проекта. Например, GitLab, GitHub, BitBucket - поддерживают.

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

git lfs install

Включить отслеживание бинарных файлов конфигурации:

git lfs track "*.cf"
git lfs track "*.bin"
git lfs track "*.png"
git lfs track "*.gif"
git lfs track "*.bmp"
git lfs track "*.jpg"
git lfs track "*.zip"

В этом примере - все файлы конфигураций поставщиков, файлы макетов с "Двоичными данными" и картинки из конфигурации попадут в lfs.

Например, чтобы переносить в LFS только некоторые типы файлов с расширением "*.bin" можно включить отслеживание только шаблонов и модулей без исходного кода по маске:

git lfs track "*/Ext/Template.bin"
git lfs track "*/Ext/Module.bin"

Копии хранилища

Копии хранилища используются для ускорения получения версий из хранилища.

Можно использовать тот же адрес серверного хранилища конфигураций, но с разными пользователями. Количество "копий" влияет на размер создаваемого глобального кэша версий на сервере хранилища "1С:Предприятия". Желательно установить кэш в настройках сервера хранилищ "1С:Предприятия" в полтора раза больше, чем количество копий в ГитКонвертере.

Укажите другой адрес архивной копии хранилища, если в текущем хранилище конфигураций выполнялось сокращение версий, и установите ограничение номеров версий в этой копии.

Укажите расписание получения версий из этой копии. Если в "копии" указан адрес основного хранилища, необходимо в расписании учесть возможность работы разработчиков с хранилищем - запуски на получение выполнять с промежутками, обеспечивающими комфортную работу разработчиков.

Очереди выполнения

Если включена константа "Использовать очереди выполнения", то для каждого хранилища конфигураций необходимо указать 2 очереди:

• Выгрузка метаданных. Начиная с версии Платформы версии 8.3.10 возможно использовать выгрузку изменений - для этого необходимо выгружать версии строго последовательно и не рекомендуется создавать более одной очереди на выгрузку.
• Загрузка метаданных.

Можно указать диапазоны количества версий для каждой очереди для разграничения "рабочей зоны".

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

Очередь может быть общей на всю базу или привязанной к конкретному хранилищу. Для очереди общего типа выбор версий для обработки выполняется по дате версии - это следует учитывать при конвертации проектов с длинной историей и более "молодых" проектов в одной базе ГитКонвертера.

Информация пользователей

Хранилище конфигураций "1С:Предприятия" использует для идентификации Пользователя, а в репозитории Git основным идентификатором является email и имя пользователя. Для этих целей предназначен регистр сведений Информация пользователей, позволяющий указать соответствие пользователей хранилищ пользователям репозитория Git.

Можно выполнять коммиты анонимно, с потерей информации об авторстве. Пользователь хранилища будет указан в дополнении к комментарию к каждой версии.

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

Обновление с версии 1.0.4

Внимание! Конвертация хранилища 1С в формат выгрузки xml 1С:Предприятия является устаревшей функциональностью и не доступна для новых настроек конвертации хранилища. Текущие настройки синхронизации хранилища, конвертирующие в формат выгрузки xml 1С:Предприятия будут работать корректно, но рекомендуется выполнить разовую конвертацию в формат 1C:EDT (см. тут) и продолжить синхронизацию в этом формате.

Функциональность конвертирования в формат xml 1С:Предприятия будет удалена в 1.0.6.

Если что-то пошло не так (FAQ)

Расписание конвертации включено, но список версий пуст

• Проверьте, что задана константа "Путь к версиям платформы на сервере" и в настройках хранилища указана версия, соответствующая версии сервера хранилища конфигураций "1С:Предприятия".
• Проверьте файл логов log.txt в каталоге выгрузок - там может быть написано что-то вразумительное.
• Проверьте журнал регистрации базы 1С:ГитКонвертера - на наличие ошибок.

Версии в списке ИБ 1С:ГитКонвертера есть, но конкретная версия зависла (зациклилась) на этапе выгрузки конфигурации в xml

• Можно посмотреть в лог пакетной операции для этой версии /каталог выгрузки версий/ХХХ/log.txt - пакетная операция Конфигуратора может сообщить что-то полезное.
• Если база версии "развалилась" в контекстном меню формы списка версий сбросить состояние версии - она будет получена заново из хранилища.

Версии обрабатываются, но не коммитятся в Git

• Проверьте, разрешен ли анонимный коммит в Git.
• Проверьте список версий хранилища - красным подсвечиваются версии, для авторов которых не указана контактная информация в регистре "Информация пользователей" .
• Нажмите кнопку "Выполнить коммиты" - для принудительного запуска коммитов обработанных версий в статусе "Метаданные загружены".

Коммиты не появляются на сервере Git

• Адрес Git-сервера был добавлен после создания хранилища? Нужно нажать кнопку "Установить адрес репозитория Git" чтобы настройки появились в config-файле.
• Откройте гит-клиент - проверьте, есть ли коммиты в локальном репозитории.
• Посмотрите лог коммита на Git-сервер, расположенные /каталог выгрузки версий/gi_log_ver_XXX.txt.
• Выполните команду git push -u origin <branch name> в консоли, чтобы проверить push вручную.
• Проверьте права доступа для пользователя, от имени которого запущен сервер "1С:Предприятия" - от его имени выполняется запуск скриптов *.bat/*.sh и глобальные настройки Git для этого пользователя.

В какой-то версии произошел сбой и файлы версии закоммичены не полностью

Т.е. в этой версии часть файлов или все были сначала удалены в репозитории, а следующая версия добавила файлы заново - сквозная история была потеряна:

• Можно установить контроль минимального количества файлов в выгрузке, чтобы такого не случалось в будущем.
• Т.к. это "односторонняя синхронизация" - то можно беспрепятственно откатить изменения git reset --hard <commit> на версию, до проблемной.
  • Далее в карточке хранилища установить поле "Версия в Git" на текущую в Git.
  • Для всех версий, начиная с "проблемной" и последующих, выполнить команду в контекстном меню "Сбросить состояние".
  • В каталоге src удалить файлы DumpFilesIndex.txt и ConfigDumpInfo.xml, т.к. они не хранятся в репозитории и не откатились.
  • Проверить что командные файлы *.bat (или *.sh) удалены для всех версий, начиная с проблемной.
  • Если была установлена настройка Git-сервера, необходимо на сервере отключить защиту ветки (если есть такое) и выполнить git push -u -f origin <branch name> принудительную передачу данных с заменой репозитория на сервере.

В хранилище версия есть, а в Git она пропущена

• Хранилище конфигураций "1С:Предприятия" позволяет сохранять новую версию без фактического изменения содержимого файлов, если меняется внутренняя версия объекта метаданных. Для Git в этом случае нечего коммитить.
• Откройте файлы логов и убедитесь в том, что версия была обработана корректно.

Файл конфигурации  GitConverter находится в каталоге \1CITS\EXE\GitConverter

Копировать