Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 4 additions & 2 deletions content/documentation/admin/actions/debug/debug.ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ extra:

| Название | Обязательность | Описание | Значение по умолчанию |
| --------------- | ---------------- | ----------------------------------------------------------------------------------------------------- | ----------------------- |
| sleep_time | Нет | Длительность одного цикла ожидания в секундах | `1` |
| sleep_count | Нет | Число циклов ожидания | `1` |
| sleep_time | Нет | Длительность одного цикла ожидания в секундах | `0` |
| sleep_count | Нет | Число циклов ожидания | `0` |
| extra | Нет | Произвольный набор пар «ключ–значение», который записывается в лог и возвращается в ответе действия | - |

При значениях `0` действие завершается сразу. Отрицательные значения не допускаются: `sleep_time and sleep_count must not be negative`.
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
title: CreateGitlabMergeRequestReview
weight: 75
---

{{< alert level="info" >}}
Для выполнения действия необходимы учётные данные `password` — токен GitLab пользователя, от имени которого будет выполнено действие.
{{< /alert >}}

CreateGitlabMergeRequestReview — создаёт merge request в GitLab из уже существующей ветки. В интерфейсе действие называется «Создать MR в Gitlab для существующей ветки».

В отличие от [CreateGitlabMergeRequest](creategitlabmergerequest/), действие не создаёт ветку и не записывает файлы, а перед созданием проверяет открытые merge request проекта. Действие используется процессом [обновления микросервиса из шаблона](../../templates/updates/).

### Пример запроса

```yaml
skipReview: false
sourceBranch: ddp/template-upgrade-1.2.0
targetBranch: main
dedupBranchPrefix: ddp/template-upgrade-
repositoryRef:
gitlabProjectId: "0"
mergeRequestSpec:
title: Upgrade template
description: Apply template upgrade changes
```

### Спецификация запроса

| Название | Обязательность | Описание | Значение по умолчанию |
| ----------------------------- | -------------- | ----------------------------------------------------------------------------------------------------- | --------------------- |
| skipReview | Нет | При значении `true` действие завершается успешно без создания merge request | `false` |
| sourceBranch | Да | Существующая ветка с изменениями | - |
| targetBranch | Нет | Ветка, в которую предлагаются изменения. Если не задана и действие выполняется для сущности микросервиса, используется значение роли маппинга `microservice_default_branch` | `main` |
| dedupBranchPrefix | Нет | Префикс веток для поиска открытых merge request | Значение «Префикс ветки обновления» реестра шаблонов, иначе `ddp/template-upgrade-` |
| repositoryRef.gitlabProjectId | Да | Идентификатор проекта GitLab. Если не задан и действие выполняется для сущности микросервиса, используется ID проекта микросервиса | - |
| mergeRequestSpec.title | Нет | Заголовок merge request | `Upgrade template (<sourceBranch>)` |
| mergeRequestSpec.description | Нет | Описание merge request | - |

### Алгоритм работы

DDP:

1. Запрашивает открытые merge request проекта, ветки которых начинаются с префикса `dedupBranchPrefix`.
1. Если открыт merge request из ветки `sourceBranch`, завершает действие успешно и возвращает этот merge request.
1. Если открыт merge request из другой ветки с тем же префиксом, завершает действие ошибкой `review_already_open: open review for branch <branch> blocks <sourceBranch>`.
1. Иначе создаёт merge request из `sourceBranch` в `targetBranch`.

Проверяется одна страница из 100 открытых merge request проекта.

### Ответ

Ответ действия содержит поля:

| Поле | Описание |
| -------------- | --------------------------------------------------------------- |
| `skipped` | `true`, если действие завершилось без создания merge request по `skipReview` |
| `deduplicated` | `true`, если возвращён уже открытый merge request |
| `provider` | Провайдер системы контроля версий, `gitlab` |
| `reviewId` | Номер merge request (`iid`) в проекте |
| `reviewUrl` | Ссылка на merge request |
| `sourceBranch` | Ветка-источник |
| `targetBranch` | Целевая ветка |

### Примечание

Действие осуществляет GET- и POST-запросы по URL: `/api/v4/projects/:id/merge_requests`. Ошибка создания merge request возвращается с кодом `review_create_failed`.
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
---
title: CreateRepositoryFromTemplatePack
weight: 12
---

{{< alert level="info" >}}
Для выполнения действия необходимы учётные данные:

- `password` — пароль (токен) пользователя, от имени которого будет выполнено действие;
- `username` — имя пользователя, от имени которого будет выполнено действие.
{{< /alert >}}

CreateRepositoryFromTemplatePack — заполняет репозиторий файлами [пакета шаблона](../../templates/packs/) из реестра шаблонов. В интерфейсе действие называется «Создать репозиторий из пакета шаблонов».

Действие загружает версию пакета, отрисовывает файлы с переданными значениями параметров, записывает в репозиторий lock-файл `.ddp/template.lock.yaml` и отправляет коммит в целевую ветку. По lock-файлу портал затем [обновляет репозиторий](../../templates/updates/) до новых версий шаблона.

### Пример запроса

```yaml
targetRepositoryUrl: https://gitlab.example.com/group/billing-api.git
targetBranch: main
templateId: go-service
templateVersion: 1.2.0
templatePackSource: company
values:
port: 8080
```

### Спецификация запроса

| Название | Обязательность | Описание | Значение по умолчанию |
| ------------------------ | -------------- | -------------------------------------------------------------------------------------------------- | --------------------- |
| targetRepositoryUrl | Да | HTTPS-адрес репозитория. Хост должен совпадать с хостом внешнего сервиса действия | - |
| targetBranch | Нет | Ветка, в которую отправляется коммит | Значение «Ветка по умолчанию» реестра шаблонов, иначе `main` |
| templateId | Да | Идентификатор шаблона | - |
| templatePackSource | Да | Название подключения в [реестре шаблонов](../../templates/registry/), из которого берётся шаблон | - |
| templateVersion | Нет | Версия шаблона в формате semver | Последняя версия шаблона |
| values | Нет | Значения параметров шаблона. Состав параметров задаёт файл `values.yaml` пакета | - |
| additionalIgnorePatterns | Нет | Дополнительные glob-шаблоны путей, которые не отрисовываются и не копируются в репозиторий | - |
| commitMessage | Нет | Сообщение коммита | `chore(template): scaffold from <templateId>@<version>` |

### Алгоритм работы

DDP:

1. Выбирает версию шаблона в реестре `templatePackSource`. Версия должна иметь статус «доступна».
1. Загружает пакет и заполняет параметры с аннотацией `x-ddp-from` из [контекста запуска процесса](../../home/processes/#создание-микросервиса).
1. Проверяет значения параметров по схеме `values.yaml` и отрисовывает файлы пакета.
1. Клонирует целевую ветку репозитория. Пустой репозиторий инициализируется.
1. Копирует отрисованные файлы, записывает lock-файл `.ddp/template.lock.yaml` с идентификатором, версией шаблона и значениями параметров.
1. Создаёт коммит и отправляет его в целевую ветку.

### Ответ

Ответ действия содержит поля `templateId`, `templateVersion`, `templateSource`, `targetBranch`, `commitSha`, а также `values.request` — переданные значения параметров и `values.merged` — итоговые значения с учётом значений по умолчанию.

### Ошибки

Сообщение об ошибке начинается с кода. Основные коды:

| Код | Причина |
| --- | --- |
| `invalid_request` | Не заданы `templateId`, `templatePackSource` или версия не в формате semver |
| `pack_unavailable` | Подключение `templatePackSource` не найдено или версия недоступна |
| `pack_not_found` | Версия шаблона не найдена |
| `pack_deprecated` | Версия шаблона отозвана |
| `values_invalid` | Значения параметров не соответствуют схеме `values.yaml` или не найден путь `x-ddp-from` в контексте запуска |
| `render_failed` | Ошибка шаблонизации файлов пакета |
| `clone_failed`, `push_failed` | Ошибка клонирования репозитория или отправки коммита |
34 changes: 34 additions & 0 deletions content/documentation/admin/actions/gitlab/getgitlabpipeline.ru.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: GetGitlabPipeline
weight: 105
---

{{< alert level="info" >}}
Для выполнения действия требуется токен пользователя, от имени которого оно будет выполнено.
{{< /alert >}}

GetGitlabPipeline — возвращает состояние пайплайна GitLab.

Действие используется в процессах, которые запускают пайплайн действием [StartGitlabPipeline](startgitlabpipeline/) и ожидают его завершения, периодически запрашивая состояние.

### Пример запроса

```yaml
project_id: "0"
pipeline_id: "0"
```

### Спецификация запроса

| Название | Обязательность | Описание |
| ----------- | -------------- | ------------------------------------------------------------------------------------------------- |
| project_id | Да | Идентификатор проекта GitLab или путь проекта, например `group/project` |
| pipeline_id | Да | Идентификатор пайплайна — поле `id` ответа GitLab, например `{{ .response.id }}` действия StartGitlabPipeline |

### Ответ

Ответ действия — объект пайплайна GitLab с полями `id`, `iid`, `status`, `ref`, `sha`, `web_url` и другими. Состояние пайплайна доступно в последующих элементах процесса как `{{ .response.status }}`.

### Примечание

Действие осуществляет GET-запрос по URL: `/api/v4/projects/:id/pipelines/:pipeline_id`.
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@ variables:
| variables.key | Да | Название переменной |
| variables.value | Да | Значение переменной |

### Ответ

Ответ действия — объект созданного пайплайна GitLab с полями `id`, `iid`, `status`, `ref`, `web_url` и другими. Идентификатор `{{ .response.id }}` используется для отслеживания состояния пайплайна действием [GetGitlabPipeline](getgitlabpipeline/).

### Примечание

Действие осуществляет POST-запрос по URL: `/api/v4/projects/:id/pipeline`.
Loading
Loading