doc: добавлен пример использования initInfobase -> additionalInitializationSteps
#130
Conversation
WalkthroughИзменения в файле Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (1)
README.md (1)
135-135: Одобрено: Улучшение документации по инициализации ИБДобавленное пояснение о автоматическом выполнении команды
vrunner vanessaулучшает понимание процесса инициализации ИБ. Это полезное дополнение к документации.Предлагаю небольшое улучшение для большей ясности:
- * Если в настройках шага инициализации не заполнен массив дополнительных шагов миграции (`initInfobase` -> `additionalInitializationSteps`), но в каталоге `tools` присутствуют файлы с именами, удовлетворяющими шаблону `vrunner.init*.json`, то автоматически выполняется запуск `vrunner vanessa` с передачей найденных файлов в качестве значения настроек (параметр `--settings`) в порядке лексикографической сортировки имен файлов. (например, `"additionalInitializationSteps": ["run --command \"СоздатьАдминистратора;Имя=Администратор;ЗавершитьРаботуСистемы\" --execute $runnerRoot\\epf\\СоздатьПользователей.epf"]` или `"additionalInitializationSteps": ["vanessa --settings ./tools/vrunner.first.json"]`) + * Если в настройках шага инициализации не заполнен массив дополнительных шагов миграции (`initInfobase` -> `additionalInitializationSteps`), но в каталоге `tools` присутствуют файлы с именами, удовлетворяющими шаблону `vrunner.init*.json`, то автоматически выполняется запуск `vrunner vanessa` с передачей найденных файлов в качестве значения настроек (параметр `--settings`) в порядке лексикографической сортировки имен файлов. + * Примеры заполнения `additionalInitializationSteps`: + - `"additionalInitializationSteps": ["run --command \"СоздатьАдминистратора;Имя=Администратор;ЗавершитьРаботуСистемы\" --execute $runnerRoot\\epf\\СоздатьПользователей.epf"]` + - `"additionalInitializationSteps": ["vanessa --settings ./tools/vrunner.first.json"]`Это разделение на отдельные пункты улучшит читаемость и понимание документации.
README.md
Outdated
| @@ -132,7 +132,7 @@ pipeline1C() | |||
| * Первичный запуск информационной базы: | |||
| * Если информационная база нужна для запуска в режиме "Предприятие" (например, для шагов `bdd` или `smoke`), то будет запущен шаг "Миграция ИБ". | |||
| * После загрузки конфигурации в ИБ будет выполняться запуск ИБ с целью запуска обработчиков обновления из БСП (`initInfobase` -> `runMigration`). | |||
| * Если в настройках шага инициализации не заполнен массив дополнительных шагов миграции (`initInfobase` -> `additionalInitializationSteps`), но в каталоге `tools` присутствуют файлы с именами, удовлетворяющими шаблону `vrunner.init*.json`, то автоматически выполняется запуск `vrunner vanessa` с передачей найденных файлов в качестве значения настроек (параметр `--settings`) в порядке лексикографической сортировки имен файлов. | |||
| * Если в настройках шага инициализации не заполнен массив дополнительных шагов миграции (`initInfobase` -> `additionalInitializationSteps`), но в каталоге `tools` присутствуют файлы с именами, удовлетворяющими шаблону `vrunner.init*.json`, то автоматически выполняется запуск `vrunner vanessa` с передачей найденных файлов в качестве значения настроек (параметр `--settings`) в порядке лексикографической сортировки имен файлов. (например, `"additionalInitializationSteps": ["run --command \"СоздатьАдминистратора;Имя=Администратор;ЗавершитьРаботуСистемы\" --execute $runnerRoot\\epf\\СоздатьПользователей.epf"]` или `"additionalInitializationSteps": ["vanessa --settings ./tools/vrunner.first.json"]`) | |||
There was a problem hiding this comment.
Это блок "По умолчанию"
Думаю поведение "не по умолчанию" - следует вынести в отдельный пункт и тут оставить ссылку
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (1)
README.md (1)
237-243: Полезное дополнение к документации, но есть возможности для улучшенияНовый раздел о настройке первичного запуска информационной базы предоставляет ценную информацию и конкретные примеры использования
additionalInitializationSteps. Однако есть несколько моментов, которые можно улучшить:
- Исправьте форматирование списка, уменьшив отступ элементов на 2 пробела для соответствия стандартам Markdown.
- Рассмотрите возможность добавления краткого пояснения к каждому примеру, чтобы пользователи лучше понимали их назначение и контекст использования.
Вот предлагаемые изменения для улучшения форматирования:
## Настройка первичного запуск информационной базы После миграции, возможно запустить дополнительные команды, используя `initInfobase` -> `additionalInitializationSteps` - * Создать пользователя Администратор `"additionalInitializationSteps": ["run --command \"СоздатьАдминистратора;Имя=Администратор;ЗавершитьРаботуСистемы\" --execute $runnerRoot\\epf\\СоздатьПользователей.epf"]`; - * Запустить Vanessa c собственными параметрами `"additionalInitializationSteps": ["vanessa --settings ./tools/vrunner.first.json"]`. +* Создать пользователя Администратор `"additionalInitializationSteps": ["run --command \"СоздатьАдминистратора;Имя=Администратор;ЗавершитьРаботуСистемы\" --execute $runnerRoot\\epf\\СоздатьПользователей.epf"]`; +* Запустить Vanessa c собственными параметрами `"additionalInitializationSteps": ["vanessa --settings ./tools/vrunner.first.json"]`.Tools
Markdownlint
241-241: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
242-242: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- README.md (2 hunks)
Additional context used
Markdownlint
README.md
241-241: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
242-242: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
Additional comments not posted (1)
README.md (1)
Line range hint
215-237: Отличное дополнение документации!Новый раздел о загрузке эталонной базы данных предоставляет четкие инструкции и полезную информацию для пользователей. Он охватывает все необходимые аспекты, включая поддерживаемые форматы файлов, типы путей и использование настроек
vanessa-runner.
README.md
Outdated
| @@ -233,6 +234,13 @@ pipeline1C() | |||
| } | |||
| ``` | |||
|
|
|||
| ## Настройка первичного запуск информационной базы | |||
There was a problem hiding this comment.
| ## Настройка первичного запуск информационной базы | |
| ## Настройка первичного запуска информационной базы |
|
|
||
| После миграции, возможно запустить дополнительные команды, используя `initInfobase` -> `additionalInitializationSteps` | ||
|
|
||
| * Создать пользователя Администратор `"additionalInitializationSteps": ["run --command \"СоздатьАдминистратора;Имя=Администратор;ЗавершитьРаботуСистемы\" --execute $runnerRoot\\epf\\СоздатьПользователей.epf"]`; |
There was a problem hiding this comment.
А в каком случае vrunner.init* не подойдут?
There was a problem hiding this comment.
Так же подойдет, но, по-моему, в варианте через run проще для понимания.
There was a problem hiding this comment.
Я промахнулся строкой с комментом. Я имел ввиду вторую строку, где запуск vanessa
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
README.md (2)
242-243: Рекомендуется улучшить форматирование примеров кода.Для лучшей читаемости рекомендуется использовать блоки кода с подсветкой синтаксиса JSON.
Предлагаю переформатировать примеры следующим образом:
-* Создать пользователя Администратор `"additionalInitializationSteps": ["run --command \"СоздатьАдминистратора;Имя=Администратор;ЗавершитьРаботуСистемы\" --execute $runnerRoot\\epf\\СоздатьПользователей.epf"]`; +* Создать пользователя Администратор: +```json +{ + "additionalInitializationSteps": [ + "run --command \"СоздатьАдминистратора;Имя=Администратор;ЗавершитьРаботуСистемы\" --execute $runnerRoot\\epf\\СоздатьПользователей.epf" + ] +} +```
240-241: Рекомендуется добавить более подробное описание.Предлагаю расширить описание, указав в каких случаях могут потребоваться дополнительные шаги инициализации и какие типы команд поддерживаются.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
README.md(2 hunks)
🔇 Additional comments (1)
README.md (1)
Line range hint 216-237: LGTM! Раздел о загрузке эталонной базы написан хорошо.
Раздел содержит всю необходимую информацию о конфигурации и поддерживаемых форматах.
No description provided.