diff --git a/docs/actions-and-automations/templates/_backend-types-json.md b/docs/actions-and-automations/templates/_backend-types-json.md index 8331a1c424..4d0ac84dfc 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: @@ -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,27 @@ Depending on the backend type you choose, the available fields will be different + + +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 | +| ------ | ---- | ------------ | --------------- | +| `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` | +| `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. +::: + +
+ `invocationMethod.type` should be set to `GITLAB`. 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.