Portn 3708 add new GitHub ocean docs changes

[sivanel97]

User description

Description

Added documentation regarding the new GitHub ocean feature SSA.

Updated docs pages

• https://docs.port.io/actions-and-automations/create-self-service-experiences/setup-the-backend/?backendType=github#json-structure

---

PR Type

Documentation

---

Description

• Added new GitHub Ocean tab with integration documentation

• Documented invocation method type as INTEGRATION_ACTION

• Added configuration table for org, repo, workflow fields

• Renamed existing GitHub tab to GitHub app for clarity

---

Diagram Walkthrough

flowchart LR
  A["GitHub Backend Docs"] --> B["Rename to GitHub app"]
  A --> C["Add GitHub Ocean Tab"]
  C --> D["INTEGRATION_ACTION Type"]
  C --> E["Configuration Fields Table"]
  E --> F["org, repo, workflow, reportWorkflowStatus, workflowInputs"]

Loading

File Walkthrough

Relevant files

Documentation

_backend-types-json.md Add GitHub Ocean backend documentation                                      docs/actions-and-automations/templates/_backend-types-json.md Renamed GitHub tab to GitHub app for better clarity Added new GitHub Ocean tab with INTEGRATION_ACTION invocation type Documented installationId field for integration selection Added comprehensive configuration table with 5 fields and descriptions +16/-1

---

[notion-workspace]

Add new GitHub Ocean docs changes

[qodo-merge-pro]

You are nearing your monthly Qodo Merge usage quota. For more information, please visit here.

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
🟢	No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
⚪	🎫 No ticket provided - [ ] Create ticket/issue <!-- /create_ticket --create_ticket=true --> </details></td></tr>
Codebase Duplication Compliance
⚪	Codebase context is not defined Follow the guide to enable codebase context checks.
Custom Compliance
⚪	No custom compliance provided Follow the guide to enable custom compliance check.
Update

Compliance status legend

🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

[qodo-merge-pro]

PR Code Suggestions ✨

Latest suggestions up to bd9c4f8

Category	Suggestion	Impact
Possible issue	✅ Document missing installationId field Suggestion Impact: The commit updated wording to reference invocationMethod.installationId for selecting the integration and corrected "Github" to "GitHub", aligning with the suggestion’s intent to document installationId usage. However, it did not add the parameters table rows/examples as suggested. code diff: -<TabItem value="github-ocean" label="Github Ocean"> +<TabItem value="github-ocean" label="GitHub Ocean"> `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 | Add the missing installationId field to the "Github Ocean" parameters table, provide a missing example for the org field, and clarify the description for workflowInputs. docs/actions-and-automations/templates/_backend-types-json.md [39-52] <TabItem value="github-ocean" label="Github Ocean"> `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` | -| `workflowInputs` | `object` | Defines the **payload** that will be sent to the backend upon execution of the action.<br/>An object containing `"key":"value"` pairs. | | +| Field | Type | Description | Example values | +| --------------------- | -------- | ------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | +| `installationId` | `string` | Identifier of the GitHub integration installation to use (as configured in Port's integration settings). | `abcd1234` | +| `org` | `string` | The GitHub organization name. | `port-labs` | +| `repo` | `string` | The GitHub repository name. | `port-docs` | +| `workflow` | `string` | GitHub workflow identifier to run (you can also pass the workflow file name). | `workflow.yml` | +| `reportWorkflowStatus`| `boolean`| Automatically update the Port run status (SUCCESS/FAILURE) at the end of the workflow. | `true` or `false` (default: `true`) | +| `workflowInputs` | `object` | Key-value inputs forwarded to the GitHub Actions workflow (workflow_dispatch inputs). | `{ "env": "prod", "version": "1.2.3" }` | </TabItem> [Suggestion processed] Suggestion importance[1-10]: 8 __ Why: The suggestion correctly identifies that the installationId field, mentioned in the description, is missing from the parameters table, which is a critical omission for users trying to use this feature.	Medium
General	Clarify workflow inputs semantics Clarify the description for workflowInputs in the "Github app" section to specify it's for workflow_dispatch inputs and add an example. Also, explicitly state the default for reportWorkflowStatus. docs/actions-and-automations/templates/_backend-types-json.md [25-37] <TabItem value="github-app" label="Github app"> `invocationMethod.type` should be set to `GITHUB`. -| Field | Type | Description | Example values | -| ---------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------- | -| `org` | `string` | The GitHub *organization* name. | `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. | | +| Field | Type | Description | Example values | +| ---------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | +| `org` | `string` | The GitHub *organization* name. | `port-labs` | +| `repo` | `string` | The GitHub *repository* name. | `port-docs` | +| `workflow` | `string` | Defines the GitHub workflow identifier to run (you can also pass the workflow file name). | `workflow.yml` | +| `reportWorkflowStatus` | `boolean` | Automatically update the Port run status (SUCCESS/FAILURE) at the end of the workflow. | `true` or `false` (default: `true`) | +| `workflowInputs` | `object` | Key-value inputs forwarded to the GitHub Actions workflow (workflow_dispatch inputs). | `{ "env": "prod", "version": "1.2.3" }` | </TabItem> Apply / Chat Suggestion importance[1-10]: 6 __ Why: The suggestion correctly identifies that the description for workflowInputs is vague and provides a much clearer explanation and example, which helps prevent user confusion and errors.	Low
	Fix GitHub capitalization in labels Standardize the capitalization of "GitHub" in the label attributes for the "Github app" and "Github Ocean" TabItem components for consistency. docs/actions-and-automations/templates/_backend-types-json.md [25] -<TabItem value="github-app" label="Github app"> +<TabItem value="github-app" label="GitHub App"> Apply / Chat Suggestion importance[1-10]: 4 __ Why: The suggestion correctly points out an inconsistent capitalization of "GitHub" in the tab labels, and fixing it improves brand consistency and professionalism in the documentation.	Low
Update

---

Previous suggestions

✅ Suggestions up to commit bd9c4f8

Category	Suggestion	Impact
High-level	Consolidate duplicated GitHub configuration documentation Refactor the documentation to avoid duplicating the configuration table for the "Github app" and "Github Ocean" sections. Create a single, shared configuration table for common fields and document the differences in their respective sections. Examples: docs/actions-and-automations/templates/_backend-types-json.md [25-37] <TabItem value="github-app" label="Github app"> `invocationMethod.type` should be set to `GITHUB`. | Field | Type | Description | Example values | | ---------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------- | | `org` | `string` | The GitHub *organization* name. | `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` | ... (clipped 3 lines) docs/actions-and-automations/templates/_backend-types-json.md [39-50] <TabItem value="github-ocean" label="Github Ocean"> `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` | | ... (clipped 2 lines) Solution Walkthrough: Before: <TabItem value="github-app" label="Github app"> `invocationMethod.type` should be set to `GITHUB`. | Field | Description | |------------------------|--------------------------------------------| | `org` | The GitHub organization name. | | `repo` | The GitHub repository name. | | `workflow` | Defines the GitHub workflow ID to run. | | `reportWorkflowStatus` | A flag to control status update. | | `workflowInputs` | Defines the payload. | </TabItem> <TabItem value="github-ocean" label="Github Ocean"> `invocationMethod.type` should be set to `INTEGRATION_ACTION`. ... | Field | Description | |------------------------|--------------------------------------------| | `org` | The GitHub organization name. | | `repo` | The GitHub repository name. | | `workflow` | Defines the GitHub workflow ID to run. | | `reportWorkflowStatus` | A flag to control status update. | | `workflowInputs` | Defines the payload. | </TabItem> After: ### Common GitHub Configuration The following fields are common for both `Github app` and `Github Ocean` integrations. | Field | Description | |------------------------|--------------------------------------------| | `org` | The GitHub organization name. | | `repo` | The GitHub repository name. | | `workflow` | Defines the GitHub workflow ID to run. | | `reportWorkflowStatus` | A flag to control status update. | | `workflowInputs` | Defines the payload. | <TabItem value="github-app" label="Github app"> `invocationMethod.type` should be set to `GITHUB`. </TabItem> <TabItem value="github-ocean" label="Github Ocean"> `invocationMethod.type` should be set to `INTEGRATION_ACTION`. You can choose which integration to use using the `installationId` field. </TabItem> Suggestion importance[1-10]: 7 __ Why: The suggestion correctly identifies significant content duplication between the Github app and Github Ocean sections, which is a valid concern for documentation maintainability.	Medium
Possible issue	✅ Add missing field to documentation Suggestion Impact: The commit updated the GitHub Ocean section to clarify that the integration is specified via invocationMethod.installationId and corrected the tab label. While it did not add the installationId row to the table, it addressed the installationId usage mentioned in the suggestion. code diff: -<TabItem value="github-ocean" label="Github Ocean"> +<TabItem value="github-ocean" label="GitHub Ocean"> `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 | | ------ | ---- | ------------ | --------------- | Add the missing installationId field to the "Github Ocean" configuration table and provide an example value for the org field to improve documentation clarity and consistency. docs/actions-and-automations/templates/_backend-types-json.md [39-52] <TabItem value="github-ocean" label="Github Ocean"> `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. | +| `installationId` | `string` | The installation ID of the GitHub integration to use. | `d1s4-b567-a9d8-e123` | +| `org` | `string` | The GitHub *organization* name. | `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` | | +| `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. | | </TabItem> Suggestion importance[1-10]: 7 __ Why: The suggestion correctly identifies that the installationId field, mentioned in the description, is missing from the configuration table. This improves documentation completeness and prevents user confusion.	Medium
General	Clarify field description for accuracy Clarify the description for the workflowInputs field in both the "Github app" and "Github Ocean" sections to accurately reflect that it provides inputs for a GitHub workflow_dispatch event. docs/actions-and-automations/templates/_backend-types-json.md [50] -| `workflowInputs` | `object` | Defines the **payload** that will be sent to the backend upon execution of the action.<br/>An object containing `"key":"value"` pairs. | | +| `workflowInputs` | `object` | An object with inputs for the `workflow_dispatch` event. The object should contain `"key":"value"` pairs, where keys are the input identifiers and values are their string values. | | Suggestion importance[1-10]: 6 __ Why: The suggestion provides a more accurate and specific description for the workflowInputs field, clarifying its purpose in the context of GitHub workflows and improving documentation quality.	Low

[aws-amplify-eu-west-1]

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-2941.d2ngvl90zqbob8.amplifyapp.com

[hadar-co]

/improve

[qodo-merge-pro]

You are nearing your monthly Qodo Merge usage quota. For more information, please visit here.

Persistent suggestions updated to latest commit bd9c4f8