Skip to content

Commit 3dcdd9b

Browse files
artbearartbear
committed
Слегка расширил описание параметров gitsync
1 parent 40c407e commit 3dcdd9b

File tree

2 files changed

+76
-72
lines changed

2 files changed

+76
-72
lines changed

‎readme.md‎

Lines changed: 73 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,35 @@
1-
#Синхронизация хранилища 1С с репозиторием git
1+
#Синхронизация хранилища 1С с репозиторием git
22

33
Обсудить [![Join the chat at https://gitter.im/EvilBeaver/oscript-library](https://badges.gitter.im/EvilBeaver/oscript-library.svg)](https://gitter.im/EvilBeaver/oscript-library?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
44

5-
## Введение
6-
Проект является глубоким рефакторингом утилиты v83unpack ([https://github.com/xDrivenDevelopment/v83unpack](https://github.com/xDrivenDevelopment/v83unpack)).
7-
8-
Изначально данный механизм представляет собой внешнюю обработку 1С:Предприятия, которая впоследствии была портирована на OneScript. [Исходные коды порта](https://github.com/xDrivenDevelopment/v83unpack/tree/develop/src/oscript) доступны в том же репозитории v83unpack.
9-
10-
Приложение *gitsync* представляет собой отдельное (standalone) приложение на 1Script, и предназначено для синхронизации хранилища конфигураций 1С с репозитарием git.
11-
12-
## Установка
13-
14-
### Вручную
15-
16-
1. Вручную - Скопировать каталог **gitsync/src** на жесткий диск
5+
## Введение
6+
Проект является глубоким рефакторингом утилиты v83unpack ([https://github.com/xDrivenDevelopment/v83unpack](https://github.com/xDrivenDevelopment/v83unpack)).
7+
8+
Изначально данный механизм представляет собой внешнюю обработку 1С:Предприятия, которая впоследствии была портирована на OneScript. [Исходные коды порта](https://github.com/xDrivenDevelopment/v83unpack/tree/develop/src/oscript) доступны в том же репозитории v83unpack.
9+
10+
Приложение *gitsync* представляет собой отдельное (standalone) приложение на 1Script, и предназначено для синхронизации хранилища конфигураций 1С с репозитарием git.
11+
12+
## Установка
13+
14+
### Вручную
15+
16+
1. Вручную - Скопировать каталог **gitsync/src** на жесткий диск
1717
2. Запустить приложение командой `oscript.exe <каталог gitsync>\src\gitsync.os`
18-
19-
### Через пакетный менеджер opm
20-
18+
19+
### Через пакетный менеджер opm
20+
2121
1. командой `opm install gitsync`
2222
2. Запустить командой `gitsync`
23-
24-
# Использование
23+
24+
# Использование
2525

2626
Возможны следующие сценарии использования/организации хранения исходников в репозитариях Git:
2727

2828
1. в одном репозитарии Git хранятся как исходники конфигурации 1С, так и прочие исходники/файлы продукта (например, документация, тесты и прочее) - `рекомендуется`
2929
+ Используем этапы:
3030
+ Клонировать средствами Git исходный репозитарий (`git clone`) или создать новый (`git init`)
3131
+ `Выполнение настройки для начала выгрузки`
32-
+ `Экспорт исходников конфигурации в сторонний репозитарий Git`
32+
+ `Синхронизация` или `Экспорт исходников конфигурации в сторонний репозитарий Git`
3333
+ далее штатные инструменты Git - `commit/pull/push`
3434

3535
2. в одном репозитарии хранятся только исходники конфигурации 1С - `не рекомендуется`
@@ -115,58 +115,62 @@
115115

116116
## Синхронизация
117117
Основной режим работы для сценария `Хранение исходников конфигурации 1С в отдельном репозитарии Git`. Аргументы командной строки для запуска:
118-
119-
* <каталог или файл хранилища>
120-
* <адрес (url) репозитария>
121-
* [локальный каталог git]
122-
* [-email домен почты пользователей]
123-
* [-v8version маска версии 1С] - маска версии в стиле стартера (8.3 или 8.3.5 или 8.2.19.109)
124-
125-
Пример:
126-
127-
cd local-git-repo
128-
gitsync c:\storage\zup http://github.com/myAccount/zup.git -v8version 8.3.6
129-
130-
## Получение справки
131-
118+
119+
* <каталог или файл хранилища>
120+
* <адрес (url) репозитария>
121+
* [Каталог исходников внутри локальной копии git-репозитария]
122+
* [-email домен почты пользователей]
123+
* [-v8version маска версии 1С] - маска версии в стиле стартера (8.3 или 8.3.5 или 8.2.19.109)
124+
125+
Пример:
126+
127+
cd local-git-repo
128+
gitsync c:\storage\zup http://github.com/myAccount/zup.git src\config -v8version 8.3.6
129+
130+
или
131+
cd local-git-repo
132+
gitsync c:\storage\zup http://github.com/myAccount/zup.git -v8version 8.3.6
133+
134+
## Получение справки
135+
132136
Справку по синтаксису команды можно получить, запустив `gitsync help <команда>`. Например:
133-
134-
gitsync help clone
135-
gitsync help init
136-
137-
## Команды
138-
139-
```
140-
Синхронизация хранилища конфигураций 1С с репозитарием GIT.
141-
Использование:
142-
gitsync <storage-path> <git-url> [local-dir] [ключи]
143-
gitsync <команда> <параметры команды> [ключи]
144-
Параметры:
145-
<ПутьКХранилищу> - Файловый путь к каталогу хранилища конфигурации 1С.
146-
<URLРепозитория> - Адрес удаленного репозитория GIT.
147-
<ЛокальныйКаталогГит> - Каталог исходников внутри локальной копии git.
148-
-email - <домен почты для пользователей git>
149-
-v8version - Маска версии платформы (8.3, 8.3.5, 8.3.6.2299 и т.п.)
150-
-debug - <on|off>
151-
-verbose - <on|off>
152-
-branch - <имя ветки git>
153-
-format - <hierarchical|plain>
154-
155-
Возможные команды:
156-
clone - Клонирует существующий репозиторий и создает служебные файлы
157-
init - Создает новый репозиторий и создает служебные файлы
158-
all - Запускает синхронизацию по нескольким репозиториям
137+
138+
gitsync help clone
139+
gitsync help init
140+
141+
## Команды
142+
143+
```
144+
Синхронизация хранилища конфигураций 1С с репозитарием GIT.
145+
Использование:
146+
gitsync <storage-path> <git-url> [local-dir] [ключи]
147+
gitsync <команда> <параметры команды> [ключи]
148+
Параметры:
149+
<ПутьКХранилищу> - Файловый путь к каталогу хранилища конфигурации 1С.
150+
<URLРепозитория> - Адрес удаленного репозитория GIT.
151+
<ЛокальныйКаталогГит> - Каталог исходников внутри локальной копии git.
152+
-email - <домен почты для пользователей git>
153+
-v8version - Маска версии платформы (8.3, 8.3.5, 8.3.6.2299 и т.п.)
154+
-debug - <on|off>
155+
-verbose - <on|off>
156+
-branch - <имя ветки git>
157+
-format - <hierarchical|plain>
158+
159+
Возможные команды:
160+
clone - Клонирует существующий репозиторий и создает служебные файлы
161+
init - Создает новый репозиторий и создает служебные файлы
162+
all - Запускает синхронизацию по нескольким репозиториям
159163
set-version - Устанавливает необходимую версию в файл VERSION
160-
help - Вывести справку по параметрам команды
161-
export - Выполнить локальную синхронизацию, без pull/push
162-
```
163-
164-
# Синхронизация по нескольким хранилищам
165-
164+
help - Вывести справку по параметрам команды
165+
export - Выполнить локальную синхронизацию, без pull/push
166+
```
167+
168+
# Синхронизация по нескольким хранилищам
169+
166170
Зачастую удобно настроить регламентную (по расписанию) синхронизацию сразу по нескольким хранилищам 1С. Для этого необходимо подготовить конфигурационный файл с параметрами синхронизации ([пример файла](config-example.xml))
167-
171+
168172
Далее необходимо запустить gitsync с командой all
169-
170-
gitsync all <путь к xml-файлу конфигурации>
171-
173+
174+
gitsync all <путь к xml-файлу конфигурации>
175+
172176
Подробнее о параметрах команды `all` можно прочитать, запустив `gitsync help all`

‎src/gitsync.os‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949

5050
Парсер.ДобавитьПозиционныйПараметрКоманды(Команда, "ПутьКХранилищу", "Файловый путь к каталогу хранилища конфигурации 1С.");
5151
Парсер.ДобавитьПозиционныйПараметрКоманды(Команда, "URLРепозитория", "Адрес удаленного репозитория GIT.");
52-
Парсер.ДобавитьПозиционныйПараметрКоманды(Команда, "ЛокальныйКаталогГит", "Каталог исходников внутри локальной копии git.");
52+
Парсер.ДобавитьПозиционныйПараметрКоманды(Команда, "ЛокальныйКаталогГит", "Каталог исходников внутри локальной копии git-репозитария.");
5353

5454
Парсер.ДобавитьИменованныйПараметрКоманды(Команда, "-email", "<домен почты для пользователей git>");
5555
Парсер.ДобавитьИменованныйПараметрКоманды(Команда, "-debug", "<on|off>");
@@ -115,7 +115,7 @@
115115
Команда = Парсер.ОписаниеКоманды("export", "Выполнить локальную синхронизацию, без pull/push");
116116

117117
Парсер.ДобавитьПозиционныйПараметрКоманды(Команда, "ПутьКХранилищу", "Файловый путь к каталогу хранилища конфигурации 1С.");
118-
Парсер.ДобавитьПозиционныйПараметрКоманды(Команда, "ЛокальныйКаталогГит", "Каталог исходников внутри локальной копии git.");
118+
Парсер.ДобавитьПозиционныйПараметрКоманды(Команда, "ЛокальныйКаталогГит", "Каталог исходников внутри локальной копии git-репозитария.");
119119

120120
Парсер.ДобавитьИменованныйПараметрКоманды(Команда, "-email", "<домен почты для пользователей git>");
121121
Парсер.ДобавитьИменованныйПараметрКоманды(Команда, "-v8version", "Маска версии платформы (8.3, 8.3.5, 8.3.6.2299 и т.п.)");
@@ -131,7 +131,7 @@
131131

132132
Парсер.ДобавитьПараметр("ПутьКХранилищу", "Файловый путь к каталогу хранилища конфигурации 1С.");
133133
Парсер.ДобавитьПараметр("URLРепозитория", "Адрес удаленного репозитория GIT.");
134-
Парсер.ДобавитьПараметр("ЛокальныйКаталогГит", "Каталог исходников внутри локальной копии git.");
134+
Парсер.ДобавитьПараметр("ЛокальныйКаталогГит", "Каталог исходников внутри локальной копии git-репозитария.");
135135

136136
Парсер.ДобавитьИменованныйПараметр("-email", "<домен почты для пользователей git>");
137137
Парсер.ДобавитьИменованныйПараметр("-v8version", "Маска версии платформы (8.3, 8.3.5, 8.3.6.2299 и т.п.)");

0 commit comments

Comments
 (0)