From b799c074227c8ec7cb26b76922a210e789a42a69 Mon Sep 17 00:00:00 2001 From: Sivan Elkabes Date: Wed, 22 Oct 2025 16:59:23 +0300 Subject: [PATCH 1/4] added the github ocean table and tab --- .../templates/_backend-types-json.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/docs/actions-and-automations/templates/_backend-types-json.md b/docs/actions-and-automations/templates/_backend-types-json.md index 8331a1c424..8a891f135d 100644 --- a/docs/actions-and-automations/templates/_backend-types-json.md +++ b/docs/actions-and-automations/templates/_backend-types-json.md @@ -22,7 +22,7 @@ Depending on the backend type you choose, the available fields will be different - + `invocationMethod.type` should be set to `GITHUB`. @@ -36,6 +36,19 @@ Depending on the backend type you choose, the available fields will be different + + +`invocationMethod.type` should be set to `GITHUB`. + +| Field | Type | Description | Example values | +| ------ | ---- | ------------ | --------------- | +| `repo` | `string` | The GitHub *repository* name. | `port-docs` | +| `workflow` | `string` | Defines the GitHub *workflow ID* to run (You can also pass the workflow file name as a string). | `workflow.yml` | | +| `reportWorkflowStatus` | `boolean` | A flag to control whether to automatically update the Port `run` object status (SUCCESS/FAILURE) at the end of the workflow (default: `true`). | `true` or `false` | +| `workflowInputs` | `object` | Defines the **payload** that will be sent to the backend upon execution of the action.
An object containing `"key":"value"` pairs. | | + + + `invocationMethod.type` should be set to `GITLAB`. From bd9c4f87438635959e35d7d9ba649f4ed3a7d8ab Mon Sep 17 00:00:00 2001 From: Sivan Elkabes Date: Thu, 23 Oct 2025 16:13:53 +0300 Subject: [PATCH 2/4] add org and other info about the invocation type --- docs/actions-and-automations/templates/_backend-types-json.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/actions-and-automations/templates/_backend-types-json.md b/docs/actions-and-automations/templates/_backend-types-json.md index 8a891f135d..a1a699b1a8 100644 --- a/docs/actions-and-automations/templates/_backend-types-json.md +++ b/docs/actions-and-automations/templates/_backend-types-json.md @@ -38,10 +38,12 @@ Depending on the backend type you choose, the available fields will be different -`invocationMethod.type` should be set to `GITHUB`. +`invocationMethod.type` should be set to `INTEGRATION_ACTION`. +You can choose which integration to use using the `installationId` field. | Field | Type | Description | Example values | | ------ | ---- | ------------ | --------------- | +| `org` | `string` | The GitHub *organization* name. | | `repo` | `string` | The GitHub *repository* name. | `port-docs` | | `workflow` | `string` | Defines the GitHub *workflow ID* to run (You can also pass the workflow file name as a string). | `workflow.yml` | | | `reportWorkflowStatus` | `boolean` | A flag to control whether to automatically update the Port `run` object status (SUCCESS/FAILURE) at the end of the workflow (default: `true`). | `true` or `false` | From cda6f73a6a255b3c0133c5a68bbbf4ab429e67b2 Mon Sep 17 00:00:00 2001 From: Sivan Elkabes Date: Thu, 23 Oct 2025 16:53:22 +0300 Subject: [PATCH 3/4] change qodo suggestion --- docs/actions-and-automations/templates/_backend-types-json.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/actions-and-automations/templates/_backend-types-json.md b/docs/actions-and-automations/templates/_backend-types-json.md index a1a699b1a8..25dff991a4 100644 --- a/docs/actions-and-automations/templates/_backend-types-json.md +++ b/docs/actions-and-automations/templates/_backend-types-json.md @@ -36,10 +36,10 @@ Depending on the backend type you choose, the available fields will be different - + `invocationMethod.type` should be set to `INTEGRATION_ACTION`. -You can choose which integration to use using the `installationId` field. +You can specify which integration to use using the `invocationMethod.installationId` field. | Field | Type | Description | Example values | | ------ | ---- | ------------ | --------------- | From 87754178cd1613091b7a491121d1cf7d114e78cf Mon Sep 17 00:00:00 2001 From: Sivan Elkabes Date: Thu, 23 Oct 2025 17:59:40 +0300 Subject: [PATCH 4/4] added the github ocean type value --- docs/actions-and-automations/templates/_backend-types-json.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/actions-and-automations/templates/_backend-types-json.md b/docs/actions-and-automations/templates/_backend-types-json.md index 25dff991a4..02a62d3df7 100644 --- a/docs/actions-and-automations/templates/_backend-types-json.md +++ b/docs/actions-and-automations/templates/_backend-types-json.md @@ -1,7 +1,7 @@ import Tabs from "@theme/Tabs" import TabItem from "@theme/TabItem" -The **`type`** field defines the action's backend type, and can have one of the following values: `WEBHOOK`, `GITHUB`, `GITLAB`, `KAFKA`, `UPSERT_ENTITY`. +The **`type`** field defines the action's backend type, and can have one of the following values: `WEBHOOK`, `GITHUB`, `INTEGRATION_ACTION`, `GITLAB`, `KAFKA`, `UPSERT_ENTITY`. Depending on the backend type you choose, the available fields will be different: