From 51bfa3e248834e9d0863490bbbbd4d067ed445bb Mon Sep 17 00:00:00 2001 From: Tapeline Date: Fri, 18 Oct 2024 01:31:39 +0500 Subject: [PATCH] Add docs to website --- docs/en/HelpTOC.json | 1 + docs/en/Map.jhm | 1 + docs/en/builtin-tasks.html | 16 +++++ docs/en/command-line-usage.html | 16 +++++ docs/en/config.json | 1 + docs/en/configuration-guide.html | 68 +++++++++++++++++++ docs/en/current.help.version | 1 + docs/en/execution-flow.html | 26 +++++++ docs/en/index.html | 9 +++ docs/en/quickstart.html | 37 ++++++++++ docs/en/site.webmanifest | 11 +++ docs/en/std-cmd.html | 22 ++++++ docs/en/std-copy.html | 25 +++++++ docs/en/std-install.html | 33 +++++++++ docs/index.html | 26 +++++++ docs/ru/HelpTOC.json | 1 + docs/ru/Map.jhm | 1 + docs/ru/config.json | 1 + docs/ru/current.help.version | 1 + docs/ru/index.html | 9 +++ docs/ru/site.webmanifest | 11 +++ docs/ru/std-cmd-ru.html | 22 ++++++ docs/ru/std-copy-ru.html | 25 +++++++ docs/ru/std-install-ru.html | 33 +++++++++ ...\201\321\202\320\260\321\200\321\202.html" | 37 ++++++++++ ...\260\320\264\320\260\321\207\320\270.html" | 16 +++++ ...\270\320\275\320\260\320\273\320\265.html" | 16 +++++ ...\200\320\260\321\206\320\270\321\217.html" | 68 +++++++++++++++++++ ...\275\320\265\320\275\320\270\321\217.html" | 26 +++++++ 29 files changed, 560 insertions(+) create mode 100644 docs/en/HelpTOC.json create mode 100644 docs/en/Map.jhm create mode 100644 docs/en/builtin-tasks.html create mode 100644 docs/en/command-line-usage.html create mode 100644 docs/en/config.json create mode 100644 docs/en/configuration-guide.html create mode 100644 docs/en/current.help.version create mode 100644 docs/en/execution-flow.html create mode 100644 docs/en/index.html create mode 100644 docs/en/quickstart.html create mode 100644 docs/en/site.webmanifest create mode 100644 docs/en/std-cmd.html create mode 100644 docs/en/std-copy.html create mode 100644 docs/en/std-install.html create mode 100644 docs/index.html create mode 100644 docs/ru/HelpTOC.json create mode 100644 docs/ru/Map.jhm create mode 100644 docs/ru/config.json create mode 100644 docs/ru/current.help.version create mode 100644 docs/ru/index.html create mode 100644 docs/ru/site.webmanifest create mode 100644 docs/ru/std-cmd-ru.html create mode 100644 docs/ru/std-copy-ru.html create mode 100644 docs/ru/std-install-ru.html create mode 100644 "docs/ru/\320\261\321\213\321\201\321\202\321\200\321\213\320\271-\321\201\321\202\320\260\321\200\321\202.html" create mode 100644 "docs/ru/\320\262\321\201\321\202\321\200\320\276\320\265\320\275\320\275\321\213\320\265-\320\267\320\260\320\264\320\260\321\207\320\270.html" create mode 100644 "docs/ru/\320\270\321\201\320\277\320\276\320\273\321\214\320\267\320\276\320\262\320\260\320\275\320\270\320\265-\320\262-\321\202\320\265\321\200\320\274\320\270\320\275\320\260\320\273\320\265.html" create mode 100644 "docs/ru/\320\272\320\276\320\275\321\204\320\270\320\263\321\203\321\200\320\260\321\206\320\270\321\217.html" create mode 100644 "docs/ru/\320\277\320\276\321\202\320\276\320\272-\320\262\321\213\320\277\320\276\320\273\320\275\320\265\320\275\320\270\321\217.html" diff --git a/docs/en/HelpTOC.json b/docs/en/HelpTOC.json new file mode 100644 index 0000000..4308997 --- /dev/null +++ b/docs/en/HelpTOC.json @@ -0,0 +1 @@ +{"entities":{"pages":{"Quickstart":{"id":"Quickstart","title":"Quickstart","url":"quickstart.html","level":0,"tabIndex":0},"Execution-flow":{"id":"Execution-flow","title":"Execution flow","url":"execution-flow.html","level":0,"tabIndex":1},"Configuration-guide":{"id":"Configuration-guide","title":"Configuration guide","url":"configuration-guide.html","level":0,"tabIndex":2},"Command-line-usage":{"id":"Command-line-usage","title":"Command line usage","url":"command-line-usage.html","level":0,"tabIndex":3},"Builtin-tasks":{"id":"Builtin-tasks","title":"Builtin tasks","url":"builtin-tasks.html","level":0,"pages":["std-install","std-copy","std-cmd"],"tabIndex":4},"std-install":{"id":"std-install","title":"std.install","url":"std-install.html","level":1,"parentId":"Builtin-tasks","tabIndex":0},"std-copy":{"id":"std-copy","title":"std.copy","url":"std-copy.html","level":1,"parentId":"Builtin-tasks","tabIndex":1},"std-cmd":{"id":"std-cmd","title":"std.cmd","url":"std-cmd.html","level":1,"parentId":"Builtin-tasks","tabIndex":2}}},"topLevelIds":["Quickstart","Execution-flow","Configuration-guide","Command-line-usage","Builtin-tasks"]} \ No newline at end of file diff --git a/docs/en/Map.jhm b/docs/en/Map.jhm new file mode 100644 index 0000000..ee0952a --- /dev/null +++ b/docs/en/Map.jhm @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/en/builtin-tasks.html b/docs/en/builtin-tasks.html new file mode 100644 index 0000000..40168d8 --- /dev/null +++ b/docs/en/builtin-tasks.html @@ -0,0 +1,16 @@ + +Builtin tasks | Embark (EN)

Embark (EN) 1.0 Help

\ No newline at end of file diff --git a/docs/en/command-line-usage.html b/docs/en/command-line-usage.html new file mode 100644 index 0000000..2ab242a --- /dev/null +++ b/docs/en/command-line-usage.html @@ -0,0 +1,16 @@ + +Command line usage | Embark (EN)

Embark (EN) 1.0 Help

Command line usage

User commands

embark run <playbook-file> [--encoding]

Run a playbook. Examples:

  • embark run playbook.yml

  • embark run playbook.yml --encoding UTF-8

Developer commands

embark dev_list_installs

Alias: embark dli

List all installed application that Embark sees on your computer

embark dev_query_install <name> --publisher <publisher> [--version] [--ignore-version]

Alias: embark dqi

Try to get specified installation from aforementioned list

  • embark dqi "LibreOffice .*" --publisher "The Document Foundation" --ignore-version

Last modified: 17 октября 2024
Configuration guideBuiltin tasks
\ No newline at end of file diff --git a/docs/en/config.json b/docs/en/config.json new file mode 100644 index 0000000..7faf241 --- /dev/null +++ b/docs/en/config.json @@ -0,0 +1 @@ +{"productVersion":"1.0","productId":"docs/en","stage":"release","downloadTitle":"Get Embark (EN)","keymaps":{},"searchMaxHits":75,"productName":"Embark (EN)"} \ No newline at end of file diff --git a/docs/en/configuration-guide.html b/docs/en/configuration-guide.html new file mode 100644 index 0000000..27c201f --- /dev/null +++ b/docs/en/configuration-guide.html @@ -0,0 +1,68 @@ + +Configuration guide | Embark (EN)

Embark (EN) 1.0 Help

Configuration guide

Schemas

From here onwards following syntax will be used for defining YAML schema

+ name: type + name: type = default value +

This is very close to syntax that Pydantic uses. Here are some examples of types and field declarations

Type

Description

Example

int

Integer (whole number)

3

str

String (text)

"my text"

list[T]

List of elements that are T type. E.g. list[int] - list of integers, list[list[int]] - list of lists of integers

list[int]: [1, 2, 3]

+ my_int_list: + - 1 + - 2 + - 3 +

object

A YAML object (key-value pairs)

+ a: 1 + b: "abc" + c: [] +

Optional[T]

Denotes that this field is optional - is T type or is not set at all

Optional[list[int]]: [1, 2, 3]

Optional[list[int]]: or we can leave this field blank or even not mentioned

None

Denotes "empty" value

Example 1:

+ schema Message: + text: str + author: str + reply_to: Optional[int] = None +
+ text: "Hello, World!" + author: "L. Torvalds" + reply_to: 13650003443 +
+ # also valid + text: "Hello, World!" + author: "L. Torvalds" +

Example 2 (considering Message from example 1):

+ schema Chat: + name: str + messages: list[Message] +
+ name: "My cozy IRC" + messages: + - text: "Hello, World!" + author: "L. Torvalds" + - text: "Hello, Linus!" + author: "R. Stallman" +

Embark entities

Playbook

+ name: str + tasks: list[Task] +

Example:

+ name: "Test playbook" + tasks: + - name: My task + std.cmd: + cmd: "" +

Task

+ name: str + _: object +

Here, _ is used for denoting any key. Learn more about it: Execution flow

Example:

+ name: My task + std.cmd: + cmd: "" +

You can find valid examples of playbook configuration on Quickstart

Last modified: 17 октября 2024
Execution flowCommand line usage
\ No newline at end of file diff --git a/docs/en/current.help.version b/docs/en/current.help.version new file mode 100644 index 0000000..9f8e9b6 --- /dev/null +++ b/docs/en/current.help.version @@ -0,0 +1 @@ +1.0 \ No newline at end of file diff --git a/docs/en/execution-flow.html b/docs/en/execution-flow.html new file mode 100644 index 0000000..c9f5f0a --- /dev/null +++ b/docs/en/execution-flow.html @@ -0,0 +1,26 @@ + +Execution flow | Embark (EN)

Embark (EN) 1.0 Help

Execution flow

Definitions

Playbook

A named sequence of tasks stored as a YAML file

+ name: My test playbook + tasks: [] +
Task

A desired state or action declaration. Defined by two objects: its display name and task data. The task's type is defined through a key under which the aforementioned task data is located.

Each task has execution criteria, execution requirements and execution target.

+ name: My test playbook + tasks: + - name: Copy file + std.copy: + src: "assets\\myfile.txt" + dst: "%UserProfile%\\Desktop\\myfile.txt" +

In this example the task's type is std.copy

Execution criteria

Used to determine whether task should be executed.

Execution requirements

List of requirements that must be met before executing the task.

Execution target

The action that will be done on task execution (if criteria and requirements meet)

Playbook execution

When a playbook is being run, all tasks are executed one-by-one in the order of declaration

How task is executed

  1. Check using execution criteria if the task should be executed. If it should not, then stop task execution and proceed to next task

  2. Check that all requirements are met. If not, then pause task execution, ask user if he wants to continue or abort execution. Then do as said.

  3. Execute the target action. If successful, then proceed to next task. If not, then pause task execution, ask user if he wants to continue or abort execution. Then do as said.

Last modified: 17 октября 2024
QuickstartConfiguration guide
\ No newline at end of file diff --git a/docs/en/index.html b/docs/en/index.html new file mode 100644 index 0000000..33ede1e --- /dev/null +++ b/docs/en/index.html @@ -0,0 +1,9 @@ + + + +You will be redirected shortly + +

Redirecting…

+Click here if you are not redirected. + + diff --git a/docs/en/quickstart.html b/docs/en/quickstart.html new file mode 100644 index 0000000..d499804 --- /dev/null +++ b/docs/en/quickstart.html @@ -0,0 +1,37 @@ + +Quickstart | Embark (EN)

Embark (EN) 1.0 Help

Quickstart

Installing Embark

There is no need to install Embark as it is portable. You just need to download executable from Releases page

Configuring your first playbook

Playbooks are series of sequential steps. Playbooks are defined in YAML. Example of an empty playbook:

+ name: My test playbook + tasks: [] +

Task is defined by two objects: its display name and task data. The task's type is defined through a key under which the aforementioned task data is located. Examples:

+ name: My test playbook + tasks: + - name: Copy file + std.copy: + src: "assets\\myfile.txt" + dst: "%UserProfile%\\Desktop\\myfile.txt" +
+ name: My test playbook + tasks: + - name: Remove old files + std.cmd: + cmd: "rm %UserProfile%\\Desktop\\myfile.txt" + + - name: Copy file + std.copy: + src: "assets\\myfile.txt" + dst: "%UserProfile%\\Desktop\\myfile.txt" +

You can find more on examples page

Last modified: 17 октября 2024
Execution flow
\ No newline at end of file diff --git a/docs/en/site.webmanifest b/docs/en/site.webmanifest new file mode 100644 index 0000000..33e6c35 --- /dev/null +++ b/docs/en/site.webmanifest @@ -0,0 +1,11 @@ +{ + "name": "JetBrains", + "short_name": "JetBrains", + "icons": [ + { "src": "https://www.jetbrains.com/icon-192.png", "type": "image/png", "sizes": "192x192" }, + { "src": "https://www.jetbrains.com/icon-512.png", "type": "image/png", "sizes": "512x512" } + ], + "theme_color": "#000000", + "background_color": "#000000", + "display": "standalone" +} \ No newline at end of file diff --git a/docs/en/std-cmd.html b/docs/en/std-cmd.html new file mode 100644 index 0000000..5049f5e --- /dev/null +++ b/docs/en/std-cmd.html @@ -0,0 +1,22 @@ + +std.cmd | Embark (EN)

Embark (EN) 1.0 Help

std.cmd

Schema

+ cmd: str # target command +

Action

Execution criteria

  • No criteria

Execution requirements

  • No requirement

Target action

  • Run target command

Examples

+ name: Remove old files + std.cmd: + cmd: rm -r data +
Last modified: 17 октября 2024
std.copy
\ No newline at end of file diff --git a/docs/en/std-copy.html b/docs/en/std-copy.html new file mode 100644 index 0000000..98ece97 --- /dev/null +++ b/docs/en/std-copy.html @@ -0,0 +1,25 @@ + +std.copy | Embark (EN)

Embark (EN) 1.0 Help

std.copy

Schema

+ src: str # source + dst: str # destination + overwrite: bool = False # overwrite existing file +

Action

Execution criteria

  • Task is executed if such destination file does not exist or overwrite flag set to true.

Execution requirements

  • No requirements

Target action

  • Copy src file to dst

Examples

+ name: Copy instructions + std.copy: + src: instructions.pdf + dst: "%UserProfile%\\Desktop\\instructions.pdf" +
Last modified: 17 октября 2024
std.installstd.cmd
\ No newline at end of file diff --git a/docs/en/std-install.html b/docs/en/std-install.html new file mode 100644 index 0000000..9ad4ef8 --- /dev/null +++ b/docs/en/std-install.html @@ -0,0 +1,33 @@ + +std.install | Embark (EN)

Embark (EN) 1.0 Help

std.install

Schema

+ name: str # name of program + publisher: str # publisher name + version: str # version string + installer: str # path to installer (exe or msi) + msi_admin: bool = False # use /A flag when installing msi + cmd_install: Optional[str] = None # replace default install command + cmd_uninstall: Optional[str] = None # replace default uninstall command + no_remove: bool = False # do not remove old version before updating + ignore_version: bool = False # no strict version match +

Action

Execution criteria

  • Task is executed if such software (determined by name, publisher and version) is not installed or has a version that differs from desired version and ignore_version: true is not set.

Execution requirements

  • Administrative privileges

Target action

  1. If software is already installed, then task tries to uninstall it by executing installer or cmd_uninstall

  2. Task executes installer or cmd_install

Examples

+ name: Install VLC + std.install: + name: VLC media player + publisher: VideoLAN + version: "3.0.21" + installer: vlc-installer.exe +

Important notes

Where to find proper name, version and publisher?

You can find them in Control Panel or using embark dev_list_installs. Learn more at: Command line usage

Last modified: 17 октября 2024
Builtin tasksstd.copy
\ No newline at end of file diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..710ad8a --- /dev/null +++ b/docs/index.html @@ -0,0 +1,26 @@ + + + + + Redirect + + + +
+

Redirecting you to localized docs

+
+ + + \ No newline at end of file diff --git a/docs/ru/HelpTOC.json b/docs/ru/HelpTOC.json new file mode 100644 index 0000000..570715d --- /dev/null +++ b/docs/ru/HelpTOC.json @@ -0,0 +1 @@ +{"entities":{"pages":{"Быстрый-старт":{"id":"Быстрый-старт","title":"Быстрый старт","url":"быстрый-старт.html","level":0,"tabIndex":0},"Поток-выполнения":{"id":"Поток-выполнения","title":"Поток выполнения","url":"поток-выполнения.html","level":0,"tabIndex":1},"Конфигурация":{"id":"Конфигурация","title":"Конфигурация","url":"конфигурация.html","level":0,"tabIndex":2},"Использование-в-терминале":{"id":"Использование-в-терминале","title":"Использование в терминале","url":"использование-в-терминале.html","level":0,"tabIndex":3},"Встроенные-задачи":{"id":"Встроенные-задачи","title":"Встроенные задачи","url":"встроенные-задачи.html","level":0,"pages":["std-install-ru","std-copy-ru","std-cmd-ru"],"tabIndex":4},"std-install-ru":{"id":"std-install-ru","title":"std.install","url":"std-install-ru.html","level":1,"parentId":"Встроенные-задачи","tabIndex":0},"std-copy-ru":{"id":"std-copy-ru","title":"std.copy","url":"std-copy-ru.html","level":1,"parentId":"Встроенные-задачи","tabIndex":1},"std-cmd-ru":{"id":"std-cmd-ru","title":"std.cmd","url":"std-cmd-ru.html","level":1,"parentId":"Встроенные-задачи","tabIndex":2}}},"topLevelIds":["Быстрый-старт","Поток-выполнения","Конфигурация","Использование-в-терминале","Встроенные-задачи"]} \ No newline at end of file diff --git a/docs/ru/Map.jhm b/docs/ru/Map.jhm new file mode 100644 index 0000000..1809168 --- /dev/null +++ b/docs/ru/Map.jhm @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/ru/config.json b/docs/ru/config.json new file mode 100644 index 0000000..bca2812 --- /dev/null +++ b/docs/ru/config.json @@ -0,0 +1 @@ +{"productVersion":"1.0","productId":"docs/ru","stage":"release","downloadTitle":"Get Embark (RU)","keymaps":{},"searchMaxHits":75,"productName":"Embark (RU)"} \ No newline at end of file diff --git a/docs/ru/current.help.version b/docs/ru/current.help.version new file mode 100644 index 0000000..9f8e9b6 --- /dev/null +++ b/docs/ru/current.help.version @@ -0,0 +1 @@ +1.0 \ No newline at end of file diff --git a/docs/ru/index.html b/docs/ru/index.html new file mode 100644 index 0000000..6e3b595 --- /dev/null +++ b/docs/ru/index.html @@ -0,0 +1,9 @@ + + + +You will be redirected shortly + +

Redirecting…

+Click here if you are not redirected. + + diff --git a/docs/ru/site.webmanifest b/docs/ru/site.webmanifest new file mode 100644 index 0000000..33e6c35 --- /dev/null +++ b/docs/ru/site.webmanifest @@ -0,0 +1,11 @@ +{ + "name": "JetBrains", + "short_name": "JetBrains", + "icons": [ + { "src": "https://www.jetbrains.com/icon-192.png", "type": "image/png", "sizes": "192x192" }, + { "src": "https://www.jetbrains.com/icon-512.png", "type": "image/png", "sizes": "512x512" } + ], + "theme_color": "#000000", + "background_color": "#000000", + "display": "standalone" +} \ No newline at end of file diff --git a/docs/ru/std-cmd-ru.html b/docs/ru/std-cmd-ru.html new file mode 100644 index 0000000..4676058 --- /dev/null +++ b/docs/ru/std-cmd-ru.html @@ -0,0 +1,22 @@ + +std.cmd | Embark (RU)

Embark (RU) 1.0 Help

std.cmd

Схема

+ cmd: str # target command +

Действие

Критерий исполнения

  • Отсутствует

Требования исполнения

  • Отсутствует

Целевое действие

  • Исполнить указанную команду

Примеры

+ name: Remove old files + std.cmd: + cmd: rm -r data +
Last modified: 17 октября 2024
std.copy
\ No newline at end of file diff --git a/docs/ru/std-copy-ru.html b/docs/ru/std-copy-ru.html new file mode 100644 index 0000000..a1770d8 --- /dev/null +++ b/docs/ru/std-copy-ru.html @@ -0,0 +1,25 @@ + +std.copy | Embark (RU)

Embark (RU) 1.0 Help

std.copy

Схема

+ src: str # source + dst: str # destination + overwrite: bool = False # overwrite existing file +

Действие

Критерий исполнения

  • Исполнится тогда, когда файл назначения не будет существовать и флаг перезаписи не будет указан как true.

Требования исполнения

  • Отсутствует

Целевое действие

  • Скопировать файл/директорию

Примеры

+ name: Copy instructions + std.copy: + src: instructions.pdf + dst: "%UserProfile%\\Desktop\\instructions.pdf" +
Last modified: 17 октября 2024
std.installstd.cmd
\ No newline at end of file diff --git a/docs/ru/std-install-ru.html b/docs/ru/std-install-ru.html new file mode 100644 index 0000000..d23f3e4 --- /dev/null +++ b/docs/ru/std-install-ru.html @@ -0,0 +1,33 @@ + +std.install | Embark (RU)

Embark (RU) 1.0 Help

std.install

Схема

+ name: str # name of program + publisher: str # publisher name + version: str # version string + installer: str # path to installer (exe or msi) + msi_admin: bool = False # use /A flag when installing msi + cmd_install: Optional[str] = None # replace default install command + cmd_uninstall: Optional[str] = None # replace default uninstall command + no_remove: bool = False # do not remove old version before updating + ignore_version: bool = False # no strict version match +

Действие

Критерий исполнения

  • Задача исполняется если такое ПО (по имени, издателю и версии) не установлено или установлено в версии, отличной от желаемой, и при этом ignore_version: true не установлен.

Требования исполнения

  • Административные привилегии

Целевое действие

  1. Если ПО уже установлено, но попытаться удалить его с помощью деинсталлятора или указанной cmd_uninstall

  2. Исполнить инсталлятор или указанную cmd_install

Примеры

+ name: Install VLC + std.install: + name: VLC media player + publisher: VideoLAN + version: "3.0.21" + installer: vlc-installer.exe +

Заметки

Где найти правильное имя, издателя и версию ПО?

Их можно найти в панели управления или с помощью embark dev_list_installs. Подробнее: Использование в терминале

Last modified: 17 октября 2024
Встроенные задачиstd.copy
\ No newline at end of file diff --git "a/docs/ru/\320\261\321\213\321\201\321\202\321\200\321\213\320\271-\321\201\321\202\320\260\321\200\321\202.html" "b/docs/ru/\320\261\321\213\321\201\321\202\321\200\321\213\320\271-\321\201\321\202\320\260\321\200\321\202.html" new file mode 100644 index 0000000..d0f5628 --- /dev/null +++ "b/docs/ru/\320\261\321\213\321\201\321\202\321\200\321\213\320\271-\321\201\321\202\320\260\321\200\321\202.html" @@ -0,0 +1,37 @@ + +Быстрый старт | Embark (RU)

Embark (RU) 1.0 Help

Быстрый старт

Установка Embark

Нет необходимости устанавливать Embark, т.к. он portable. Просто скачайте его со страницы Releases

Создание плейбука

Плейбук - это последовательность шагов исполнения, определенная в формате YAML. Пример пустого плейбука:

+ name: My test playbook + tasks: [] +

Задачи определяются двумя объектами: именем задачи и данными задачи. Тип задачи определяется с помощью ключа, под которым лежат вышеупомянутые данные задачи. Примеры:

+ name: My test playbook + tasks: + - name: Copy file + std.copy: + src: "assets\\myfile.txt" + dst: "%UserProfile%\\Desktop\\myfile.txt" +
+ name: My test playbook + tasks: + - name: Remove old files + std.cmd: + cmd: "rm %UserProfile%\\Desktop\\myfile.txt" + + - name: Copy file + std.copy: + src: "assets\\myfile.txt" + dst: "%UserProfile%\\Desktop\\myfile.txt" +

Найдите больше примеров тут:

Last modified: 17 октября 2024
Поток выполнения
\ No newline at end of file diff --git "a/docs/ru/\320\262\321\201\321\202\321\200\320\276\320\265\320\275\320\275\321\213\320\265-\320\267\320\260\320\264\320\260\321\207\320\270.html" "b/docs/ru/\320\262\321\201\321\202\321\200\320\276\320\265\320\275\320\275\321\213\320\265-\320\267\320\260\320\264\320\260\321\207\320\270.html" new file mode 100644 index 0000000..b9a0337 --- /dev/null +++ "b/docs/ru/\320\262\321\201\321\202\321\200\320\276\320\265\320\275\320\275\321\213\320\265-\320\267\320\260\320\264\320\260\321\207\320\270.html" @@ -0,0 +1,16 @@ + +Встроенные задачи | Embark (RU)

Embark (RU) 1.0 Help

\ No newline at end of file diff --git "a/docs/ru/\320\270\321\201\320\277\320\276\320\273\321\214\320\267\320\276\320\262\320\260\320\275\320\270\320\265-\320\262-\321\202\320\265\321\200\320\274\320\270\320\275\320\260\320\273\320\265.html" "b/docs/ru/\320\270\321\201\320\277\320\276\320\273\321\214\320\267\320\276\320\262\320\260\320\275\320\270\320\265-\320\262-\321\202\320\265\321\200\320\274\320\270\320\275\320\260\320\273\320\265.html" new file mode 100644 index 0000000..84b098f --- /dev/null +++ "b/docs/ru/\320\270\321\201\320\277\320\276\320\273\321\214\320\267\320\276\320\262\320\260\320\275\320\270\320\265-\320\262-\321\202\320\265\321\200\320\274\320\270\320\275\320\260\320\273\320\265.html" @@ -0,0 +1,16 @@ + +Использование в терминале | Embark (RU)

Embark (RU) 1.0 Help

Использование в терминале

Пользовательские команды

embark run <playbook-file> [--encoding]

Выполнить плейбук. Примеры:

  • embark run playbook.yml

  • embark run playbook.yml --encoding UTF-8

Команды для разработчиков

embark dev_list_installs

Alias: embark dli

Список всего установленного ПО

embark dev_query_install <name> --publisher <publisher> [--version] [--ignore-version]

Alias: embark dqi

Попытаться получить определенное ПО из вышеупомянутого списка

  • embark dqi "LibreOffice .*" --publisher "The Document Foundation" --ignore-version

Last modified: 17 октября 2024
КонфигурацияВстроенные задачи
\ No newline at end of file diff --git "a/docs/ru/\320\272\320\276\320\275\321\204\320\270\320\263\321\203\321\200\320\260\321\206\320\270\321\217.html" "b/docs/ru/\320\272\320\276\320\275\321\204\320\270\320\263\321\203\321\200\320\260\321\206\320\270\321\217.html" new file mode 100644 index 0000000..c911dc3 --- /dev/null +++ "b/docs/ru/\320\272\320\276\320\275\321\204\320\270\320\263\321\203\321\200\320\260\321\206\320\270\321\217.html" @@ -0,0 +1,68 @@ + +Конфигурация | Embark (RU)

Embark (RU) 1.0 Help

Конфигурация

Схемы

Отсюда и далее будет использоваться следующий синтаксис для определения YAML schema

+ name: type + name: type = default value +

Почти то же самое, что и Pydantic. Примеры:

Тип

Описание

Пример

int

Целое число

3

str

Строка (текст)

"my text"

list[T]

Список элементов типа T. К примеру, list[int] - список целых чисел, list[list[int]] - список списков целых чисел

list[int]: [1, 2, 3]

+ my_int_list: + - 1 + - 2 + - 3 +

object

YAML объект (пары ключ-значение)

+ a: 1 + b: "abc" + c: [] +

Optional[T]

Определяет это поле как опциональное - оно либо типа T, либо вообще не задано

Optional[list[int]]: [1, 2, 3]

Optional[list[int]]: или мы можем вообще не задавать это поле

None

Определяет "пустое" значение

Пример 1:

+ schema Message: + text: str + author: str + reply_to: Optional[int] = None +
+ text: "Hello, World!" + author: "L. Torvalds" + reply_to: 13650003443 +
+ # also valid + text: "Hello, World!" + author: "L. Torvalds" +

Пример 2 (беря в счет Message из примера 1):

+ schema Chat: + name: str + messages: list[Message] +
+ name: "My cozy IRC" + messages: + - text: "Hello, World!" + author: "L. Torvalds" + - text: "Hello, Linus!" + author: "R. Stallman" +

Embark entities

Playbook

+ name: str + tasks: list[Task] +

Example:

+ name: "Test playbook" + tasks: + - name: My task + std.cmd: + cmd: "" +

Task

+ name: str + _: object +

Здесь _ используется для определения любого ключа. Подробнее: Поток выполнения

Пример:

+ name: My task + std.cmd: + cmd: "" +

Другие примеры можно найти на Быстрый старт

Last modified: 17 октября 2024
Поток выполненияИспользование в терминале
\ No newline at end of file diff --git "a/docs/ru/\320\277\320\276\321\202\320\276\320\272-\320\262\321\213\320\277\320\276\320\273\320\275\320\265\320\275\320\270\321\217.html" "b/docs/ru/\320\277\320\276\321\202\320\276\320\272-\320\262\321\213\320\277\320\276\320\273\320\275\320\265\320\275\320\270\321\217.html" new file mode 100644 index 0000000..634885b --- /dev/null +++ "b/docs/ru/\320\277\320\276\321\202\320\276\320\272-\320\262\321\213\320\277\320\276\320\273\320\275\320\265\320\275\320\270\321\217.html" @@ -0,0 +1,26 @@ + +Поток выполнения | Embark (RU)

Embark (RU) 1.0 Help

Поток выполнения

Определения

Плейбук

Именованная последовательность задач, хранящаяся в YAML файле

+ name: My test playbook + tasks: [] +
Задача

Определение желаемого состояния или действия. Определяется двумя объектами: именем задачи и данными задачи. Тип задачи определяется с помощью ключа, под которым лежат вышеупомянутые данные задачи.

Каждая задача имеет критерий исполнения, требования исполнения и целевое действие

+ name: My test playbook + tasks: + - name: Copy file + std.copy: + src: "assets\\myfile.txt" + dst: "%UserProfile%\\Desktop\\myfile.txt" +

В этом примере тип задачи - std.copy

Критерий исполнения

Определяет, должна ли выполняться эта задача

Требования исполнения

Список требований, которые должны быть соблюдены для корректной работы задачи

Целевое действие

Выполняемое задачей действие

Исполнение плейбуков

Когда плейбук выполняется, все задачи выполняются одна за другой в порядке определения

Как исполняется задача

  1. Проверить с помощью критерия исполнения, нужно ли выполнять задачу. Если нет, то перейти к следующей.

  2. Убедиться, что все требования выполняются. Если нет, приостановить работу и ждать решения пользователя: остановить или продолжить работу.

  3. Выполнить целевое действие. Если успешно, то перейти к следующей задаче. Если нет, приостановить работу и ждать решения пользователя: остановить или продолжить работу.

Last modified: 17 октября 2024
Быстрый стартКонфигурация
\ No newline at end of file