Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Добавлено описание опции команды syns для расширений #322

Merged
merged 1 commit into from
Sep 5, 2024
Merged

Добавлено описание опции команды syns для расширений #322

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/sync.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ sync (синоним s) - Выполняет синхронизацию хран
Опции:
-u, --storage-user пользователь хранилища конфигурации (env $GITSYNC_STORAGE_USER) (по умолчанию Администратор)
-p, --storage-pwd пароль пользователя хранилища конфигурации (env $GITSYNC_STORAGE_PASSWORD, $GITSYNC_STORAGE_PWD)
-e, --ext имя расширения для работы с хранилищем расширения(env $GITSYNC_EXTENSION)

```
### Глобальные переменные окружения
Expand All @@ -36,6 +37,7 @@ sync (синоним s) - Выполняет синхронизацию хран
| `GITSYNC_STORAGE_PATH` | путь к хранилищу конфигурации 1С. |
| `GITSYNC_STORAGE_USER` | пользователь хранилища конфигурации |
| `GITSYNC_STORAGE_PASSWORD` | пароль пользователя хранилища конфигурации |
| `GITSYNC_EXTENSION` | имя расширения |

### Значения по умолчанию

Expand All @@ -52,6 +54,12 @@ sync (синоним s) - Выполняет синхронизацию хран

Данная команда выполнить синхронизацию хранилища 1С по пути `C:/Хранилище_1С/` и репозитория git в каталоге `C:/GIT/src`

* Простое использование для выгрузки расширения конфигурации

`gitsync sync --ext ИМЯ_Расширения C:/Хранилище_1С/ C:/GIT/src`

Данная команда выполняет синхронизацию хранилища расширения 1С с именем `ИМЯ_Расширения` по пути `C:/Хранилище_1С/` и репозитория git в каталоге `C:/GIT/src`

* Инициализация в текущем рабочем каталоге,

> переменная окружения **`GITSYNC_WORKDIR`** не должна быть задана
Expand Down
25 changes: 16 additions & 9 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,34 +209,35 @@
Опции:
-u, --storage-user пользователь хранилища конфигурации (env $GITSYNC_STORAGE_USER) (по умолчанию Администратор)
-p, --storage-pwd пароль пользователя хранилища конфигурации (env $GITSYNC_STORAGE_PASSWORD, $GITSYNC_STORAGE_PWD)

-e, --ext имя расширения для работы с хранилищем расширения(env $GITSYNC_EXTENSION)
```

<a id="markdown-глобальные-переменные-окружения" name="глобальные-переменные-окружения"></a>
#### Глобальные переменные окружения
| Имя | Описание |
|---------------------|--------------------------------------------------------|
| `GITSYNC_V8VERSION` | маска версии платформы (8.3, 8.3.5, 8.3.6.2299 и т.п.) |
| Имя | Описание |
| ------------------- | --------------------------------------------------------------------------- |
| `GITSYNC_V8VERSION` | маска версии платформы (8.3, 8.3.5, 8.3.6.2299 и т.п.) |
| `GITSYNC_V8_PATH` | путь к исполняемому файлу платформы 1С (Например, /opt/1C/v8.3/x86_64/1cv8) |
| `GITSYNC_VERBOSE` | вывод отладочной информации в процессе выполнения |
| `GITSYNC_TEMP` | путь к каталогу временных файлов |
| `GITSYNC_EMAIL` | домен почты для пользователей git |
| `GITSYNC_VERBOSE` | вывод отладочной информации в процессе выполнения |
| `GITSYNC_TEMP` | путь к каталогу временных файлов |
| `GITSYNC_EMAIL` | домен почты для пользователей git |

<a id="markdown-переменные-окружения-команды" name="переменные-окружения-команды"></a>
#### Переменные окружения команды

| Имя | Описание |
|----------------------------|--------------------------------------------|
| -------------------------- | ------------------------------------------ |
| `GITSYNC_WORKDIR` | рабочий каталог для команды |
| `GITSYNC_STORAGE_PATH` | путь к хранилищу конфигурации 1С. |
| `GITSYNC_STORAGE_USER` | пользователь хранилища конфигурации |
| `GITSYNC_STORAGE_PASSWORD` | пароль пользователя хранилища конфигурации |
| `GITSYNC_EXTENSION` | имя расширения |

<a id="markdown-значения-по-умолчанию" name="значения-по-умолчанию"></a>
#### Значения по умолчанию

| | |
|--------------------|------------------------------|
| ------------------ | ---------------------------- |
| WORKDIR | текущая рабочая директория |
| -u, --storage-user | пользователь `Администратор` |

Expand All @@ -249,6 +250,12 @@

Команда выполнит выгрузку версий хранилища 1С из `C:/Хранилище_1С/` в репозиторий git в каталоге `C:/GIT/src`. Пример учебный, на практике обычно требуется указать также имя пользователя хранилища и пароль.

* Вариант для расширения конфигурации

`gitsync sync --ext ИМЯ_Расширения C:/Хранилище_1С/ C:/GIT/src`

Команда выполнит выгрузку версий хранилища расширения 1С из `C:/Хранилище_1С/` для расширения `ИМЯ_Расширения` в репозиторий git в каталоге `C:/GIT/src`.

* Вариант вызова команды в текущем рабочем каталоге

> переменная окружения **`GITSYNC_WORKDIR`** не должна быть задана
Expand Down