From b799c074227c8ec7cb26b76922a210e789a42a69 Mon Sep 17 00:00:00 2001 From: Sivan Elkabes Date: Wed, 22 Oct 2025 16:59:23 +0300 Subject: [PATCH 1/6] 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/6] 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/6] 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/6] 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: From 214fd9a7854a07e9a4e82805e5bade46ecc9a757 Mon Sep 17 00:00:00 2001 From: Sivan Elkabes Date: Sun, 2 Nov 2025 15:55:48 +0200 Subject: [PATCH 5/6] update the github organization field description --- 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 02a62d3df7..22b5bde909 100644 --- a/docs/actions-and-automations/templates/_backend-types-json.md +++ b/docs/actions-and-automations/templates/_backend-types-json.md @@ -43,7 +43,7 @@ You can specify which integration to use using the `invocationMethod.installatio | Field | Type | Description | Example values | | ------ | ---- | ------------ | --------------- | -| `org` | `string` | The GitHub *organization* name. | +| `org` | `string` | The GitHub *organization* name. If the *organization* was specified when installing the integration, the field will be prefilled automatically. Otherwise, specify the organization where the workflow resides. | `port-labs` | | `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 734dde8fac76e72bd53c7406a8678acf5056799e Mon Sep 17 00:00:00 2001 From: Sivan Elkabes Date: Wed, 5 Nov 2025 16:29:01 +0200 Subject: [PATCH 6/6] added deprecation notice to GitHub as well as the note Omri provided me about the token requirements --- .../templates/_backend-types-json.md | 8 +++++++- .../sync-data-to-catalog/git/github/_category_.json | 2 +- .../sync-data-to-catalog/git/github/github.md | 6 +++++- 3 files changed, 13 insertions(+), 3 deletions(-) diff --git a/docs/actions-and-automations/templates/_backend-types-json.md b/docs/actions-and-automations/templates/_backend-types-json.md index 22b5bde909..4d0ac84dfc 100644 --- a/docs/actions-and-automations/templates/_backend-types-json.md +++ b/docs/actions-and-automations/templates/_backend-types-json.md @@ -38,7 +38,8 @@ Depending on the backend type you choose, the available fields will be different -`invocationMethod.type` should be set to `INTEGRATION_ACTION`. +The `invocationMethod.type` should be set to `INTEGRATION_ACTION`. + You can specify which integration to use using the `invocationMethod.installationId` field. | Field | Type | Description | Example values | @@ -49,6 +50,11 @@ You can specify which integration to use using the `invocationMethod.installatio | `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. | | +:::info Token requirements +This invocation method works only with integrations that use Port machine tokens (organization-level tokens). +Personal tokens or service account tokens are not supported at the moment. +::: + diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github/_category_.json b/docs/build-your-software-catalog/sync-data-to-catalog/git/github/_category_.json index a004afe939..768eba1551 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github/_category_.json +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github/_category_.json @@ -1,4 +1,4 @@ { - "label": "GitHub", + "label": "GitHub (deprecated)", "position": 1 } diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/github/github.md b/docs/build-your-software-catalog/sync-data-to-catalog/git/github/github.md index f57aa3bc24..5a7563534d 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/github/github.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/github/github.md @@ -2,7 +2,11 @@ import Tabs from "@theme/Tabs" import TabItem from "@theme/TabItem" import GitHubResources from './\_github_exporter_supported_resources.mdx' -# GitHub +# GitHub (deprecated) + +:::warning Deprecation Notice +This integration is deprecated and will be discontinued soon, please use the [GitHub self-hosted](/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/) integration instead. +::: Port's GitHub integration allows you to model GitHub resources in your software catalog and ingest data into them.