- Введение
- Установка
- Особенности
- Использование приложения
gitsync
- Использование библиотеки
gitsync
- Доработка и разработка плагинов
- Механизм подписок на события
- Сборка проекта
- Доработка
- Лицензия
Возможно данный проект примут как следующую версию в gitsync
Проект является форком проекта gitsync см. https://github.com/oscript-library/gitsync и результатом глубокого рефакторинга начального проекта
Проект gitsync представляет собой:
- Библиотеку
gitsync
(src/core
) - которая реализует основные классы для синхронизации хранилища 1С с git - Приложение
gitsync
(src/cmd
) - консольное приложение на основе библиотекиcli
Документация и описание публичного API библиотеки
- Скачать файл
gitsync*.ospx
из раздела releases - Воспользоваться командой:
$ opm install -f <ПутьКФайлу>
- командой
opm install gitsync
- Запустить командой
gitsync
- Полностью другая строка вызова приложения, а именно используется стандарт POSIX.
- Работа с хранилищем конфигурации реализовано на основании библиотеки
v8storage
- Реализована поддержка работы с
http
иtcp
хранилищами - Функциональность работы через
tool1CD
- перенесена в предустановленный плагинtool1CD
- Вместо двух команд
sync
иexport
оставлена только одна командаsync
, которая работает как командаexport
в предыдущих версиях, при это функциональность синхронизации с удаленным репозиторием (командыgit pull
иgit push
) перенесена в отдельный плагинsync-remote
- Отказ от поддержки работы с форматом
plain
при выгрузке конфигурации в исходники - Отказ от поддержки файла
renames.txt
и переименования длинных файлов - Расширяемость функционала за счет использования механизма подписок на события
- Пока не поддерживается синхронизация с несколькими хранилищами одновременно. (команда
all
)
Раздел документации в разработке
Данный шаг можно пропустить, если у Вас уже готова рабочая копия git репозитория
- Если у Вас уже есть удаленный репозиторий (уже делалась синхронизация с git) и вы проводили синхронизацию тогда следует воспользоваться командой
clone
Пример использования:
gisync clone --storage-user Администратор --storage-pwd Секрет <путь_к_хранилищу_1С> <адрес_удаленного_репозитория> <рабочий_каталог>(необязательный)
Справка по команде clone
: gitsync clone --help
Больше примеров можно увидеть, использовав команду gitsync usage clone
- Если у Вас нет удаленного репозитория, тогда стоит воспользоваться командой
init
для выполнения начальной настройки и наполнения данными рабочего каталог
Пример использования:
gitsync init --storage-user Администратор --storage-pwd Секрет C:/Хранилище_1С/ C:/GIT/src
Данная команда создаст новый репозиторий git в каталоге C:/GIT/src
из хранилища 1С по пути C:/Хранилище_1С/
и наполнил его служебными файлами VERSION
и AUTHORS
Справка по команде init
: gitsync init --help
Больше примеров можно увидеть, использовав команду gitsync usage init
Данный шаг можно пропустить, если у Вас уже установлено соответствие пользователей хранилища 1с и git
Для настройки соответствия между пользователями хранилища 1с и git предназначен Файл AUTHORS
.
Данный файл имеет формат ini
файла.
Пример файла:
Администратор=Пользователь1 <[email protected]>
Вася Иванов=Другой Пользователь <[email protected]>
слева указано имя пользователя хранилища 1С справа - представление имени пользователя репозитория Git и его e-mail
С помощью e-mail выполняется связка пользователя с публичными репозиториями (например, Github или Bitbucket)
Данный шаг можно пропустить, если у Вас уже установлена или заполнения версия в файле
VERSION
Для настройки последней синхронизированной(выгруженной в рабочий каталог) версии хранилища 1С служит файл VERSION
.
Данный файл имеет формат xml
Пример файла, в котором указано, что выгружено 10 версий:
<?xml version="1.0" encoding="UTF-8"?>
<VERSION>10</VERSION>
Данный файл можно отредактировать в ручную или воспользовавшись командой set-version
.
Пример использования:
gitsync set-version <номер_версии> <рабочий_каталог>(необязательный)
Данная команда установит указанную версию <номер_версии>
в файл VERSION
, который лежит в каталоге <рабочий_каталог>
Справка по команде set-version
: gitsync set-version --help
Для удобства использования команда set-version
имеет короткое название sv
.
Больше примеров можно увидеть, использовав команду gitsync usage set-version
Данный пункт можно пропустить, если Вам не требуется дополнительная функциональность синхронизации
Для расширения функциональности синхронизации предлагается механизм плагинов. Данный механизм реализован через подписки на события синхронизации, с возможностью переопределения стандартной обработки.
Для обеспечения управления плагинами реализована подкоманда plugins
, а так же ряд вложенных команд:
init
- Инициализация предустановленных плагиновlist
- Вывод списка плагиновenable
- Активизация установленных плагиновdisable
- Деактивизация установленных плагиновinstall
- Установка новых плагиновclear
- Очистка установленных плагиновhelp
- Вывод справки по выбранным плагинам
Пример использования:
gitsync plugins enable limit
- будет активирован плагинlimit
gitsync plugins list
- будет выведен список всех активированных плагиновgitsync plugins list -a
- будет выведен список всех установленных плагинов
Справка по команде plugins
: gitsync plugins --help
Для удобства использования команда plugins
имеет короткое название p
.
Больше примеров можно увидеть, использовав команду gitsync usage plugins
Для хранения установленных плагинов и списка активных плагинов используется каталог
локальных данных приложения
Список предустановленных плагинов:
Для инициализации предустановленных плагинов необходимо выполнить команду
gitsync plugins init
increment
- обеспечивает инкрементальную выгрузку конфигурации в исходникиsync-remote
- добавляет функциональность синхронизации с удаленным репозиторием git (командыgit pull
иgit push
)limit
- добавляет возможность ограничения на минимальный, максимальный номер версии хранилища, а так же на лимит на количество выгружаемых версий за один запускcheck-authors
- добавляет функциональность проверки автора версии в хранилище на наличие соответствия в файлеAUTHORS
check-comments
- добавляет функциональность проверки на заполненность комментариев в хранилищеsmart-tags
- добавляет функциональность автоматической расстановки меток в git (командаgit tag
) при изменении версии конфигурацииunpackForm
- добавляет функциональность распаковки обычных форм на исходникиtool1CD
- заменяет использование штатных механизмов 1С на приложениеtool1CD
при синхронизацииdisable-support
- снимает конфигурацию с поддержки перед выгрузкой в исходники
Команда sync
(синоним s) - выполняет синхронизацию хранилища 1С с git-репозиторием
Подробную справку по опциям и аргументам см.
gitsync sync --help
Команда: sync, s
Выполняет синхронизацию хранилища 1С с git-репозиторием
Строка запуска: gitsync sync [ОПЦИИ] PATH [WORKDIR]
Аргументы:
PATH Путь к хранилищу конфигурации 1С. (env $GITSYNC_STORAGE_PATH)
WORKDIR Каталог исходников внутри локальной копии git-репозитария. (env $GITSYNC_WORKDIR)
Опции:
-u, --storage-user пользователь хранилища конфигурации (env $GITSYNC_STORAGE_USER) (по умолчанию Администратор)
-p, --storage-pwd пароль пользователя хранилища конфигурации (env $GITSYNC_STORAGE_PASSWORD, $GITSYNC_STORAGE_PWD)
Имя | Описание |
---|---|
GITSYNC_V8VERSION |
маска версии платформы (8.3, 8.3.5, 8.3.6.2299 и т.п.) |
GITSYNC_VERSOBE |
вывод отладочной информация в процессе выполнении |
GITSYNC_TEMP |
путь к каталогу временных файлов |
GITSYNC_EMAIL |
домен почты для пользователей git |
Имя | Описание |
---|---|
GITSYNC_WORKDIR |
рабочий каталог для команды |
GITSYNC_STORAGE_PATH |
путь к хранилищу конфигурации 1С. |
GITSYNC_STORAGE_USER |
пользователь хранилища конфигурации |
GITSYNC_STORAGE_PASSWORD |
пароль пользователя хранилища конфигурации |
WORKDIR | текущая рабочая директория |
-u, --storage-user | пользователь Администратор |
-
Простое использование
gitsync sync C:/Хранилище_1С/ C:/GIT/src
Данная команда выполнить синхронизацию хранилища 1С по пути
C:/Хранилище_1С/
и репозитория git в каталогеC:/GIT/src
-
Инициализация в текущем рабочем каталоге,
переменная окружения
GITSYNC_WORKDIR
не должна быть заданаcd C:/work_dir/ gitsync sync C:/Хранилище_1С/
Данная команда выполнить синхронизацию хранилища 1С по пути
C:/Хранилище_1С/
и репозитория git в каталогеC:/work_dir
-
Инициализация в с указанием пользователя и пароля.
gitsync sync --storage-user Admin --storage-pwd=Secret C:/Хранилище_1С/ C:/work_dir/
Данная команда выполнить синхронизацию хранилища 1С по пути
C:/Хранилище_1С/
и репозитория git в каталогеC:/work_dir
Используя для подключения к хранилищу 1С пользователяAdmin
и парольSecret
-
Использование синонимов (короткая версия предыдущего примера)
gitsync s -uAdmin -p=Secret C:/Хранилище_1С/ C:/work_dir/
Данная команда выполнить синхронизацию хранилища 1С по пути
C:/Хранилище_1С/
и репозитория git в каталогеC:/work_dir
Используя для подключения к хранилищу 1С пользователяAdmin
и парольSecret
-
Использование только переменных окружения
linux:
export GITSYNC_WORKDIR=./work_dir/ export GITSYNC_STORAGE_PATH=./Хранилище_1С/ export GITSYNC_STORAGE_USER=Admin export GITSYNC_STORAGE_PASSWORD=Secret export GITSYNC_V8VERSION=8.3.7 export GITSYNC_VERSOBE=true #Можно использовать Да/Ложь/Нет/Истина export GITSYNC_TEMP=./temp/sync gitsync s
windows:
set GITSYNC_WORKDIR=./work_dir/ set GITSYNC_STORAGE_PATH=./Хранилище_1С/ set GITSYNC_STORAGE_USER=Admin set GITSYNC_STORAGE_PASSWORD=Secret set GITSYNC_V8VERSION=8.3.7 set GITSYNC_VERSOBE=true #Можно использовать Да/Ложь/Нет/Истина set GITSYNC_TEMP=./temp/sync gitsync s
Данная команда выполнить синхронизацию хранилища 1С по пути
C:/Хранилище_1С/
и репозитория git в каталогеC:/work_dir
Используя для подключения к хранилищу 1С пользователяAdmin
и парольSecret
Раздел документации в разработке
Как разработать свой или доработать текущие плагины
- Как создать свой плагин
- Доработка предустановленных плагинов производиться в отдельном репозитории gitsync-plugins
Раздел документации в разработке
Проект gitsync
поддерживает ряд подписок на события
Сборка производится в 2-х режимах:
-
Сборка обычного пакета (без зависимостей)
opm build .
при данной сборки не собираются предустановленные пакеты. Их надо будет устанавливать отдельно
-
Сборка пакета с зависимостями
opm build -mf ./build_packagedef .
При данной сборке будут дополнительно собраны из репозиториев:
opm
- из ветки developgitsync-pre-plugins
- из вертки develop
Доработка проводится по git-flow. Жду ваших PR.
Смотри файл LICENSE
.