Skip to content

Portn 3708 add new GitHub ocean docs changes #2941

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Portn 3708 add new GitHub ocean docs changes #2941

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b799c07
added the github ocean table and tab
sivanel97 Oct 22, 2025
bd9c4f8
add org and other info about the invocation type
sivanel97 Oct 23, 2025
cda6f73
change qodo suggestion
sivanel97 Oct 23, 2025
8775417
added the github ocean type value
sivanel97 Oct 23, 2025
214fd9a
update the github organization field description
sivanel97 Nov 2, 2025
734dde8
added deprecation notice to GitHub as well as the note Omri provided …
sivanel97 Nov 5, 2025
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
25 changes: 23 additions & 2 deletions docs/actions-and-automations/templates/_backend-types-json.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:

Expand All @@ -22,7 +22,7 @@ Depending on the backend type you choose, the available fields will be different

</TabItem>

<TabItem value="github" label="Github">
<TabItem value="github-app" label="Github app">

`invocationMethod.type` should be set to `GITHUB`.

Expand All @@ -36,6 +36,27 @@ Depending on the backend type you choose, the available fields will be different

</TabItem>

<TabItem value="github-ocean" label="GitHub Ocean">

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.<br/>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.
:::

</TabItem>

<TabItem value="gitlab" label="Gitlab">

`invocationMethod.type` should be set to `GITLAB`.
Expand Down
2 changes: 1 addition & 1 deletion docs/build-your-software-catalog/sync-data-to-catalog/git/github/_category_.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "GitHub",
"label": "GitHub (deprecated)",
"position": 1
}
6 changes: 5 additions & 1 deletion docs/build-your-software-catalog/sync-data-to-catalog/git/github/github.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down