You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/github-ocean.md
+5-6Lines changed: 5 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ Here's what you can do with the GitHub integration:
22
22
23
23
### Multi-organization support
24
24
25
-
The GitHub integration supports syncing data from multiple GitHub organizations starting from **version 3.0.0-beta**. You can configure which organizations to sync using a single-org `githubOrganization`, or by listing organizations in your Port mapping (`organizations`).
25
+
The GitHub integration supports syncing data from multiple GitHub organizations starting from **version 3.0.0-beta**. You can configure which organizations to sync using a single-org `githubOrganization`, or by listing organizations in your port mapping (`organizations`).
26
26
27
27
<details>
28
28
<summary><b>Mapping multi organizations (Click to expand)</b></summary>
@@ -41,11 +41,10 @@ organizations:
41
41
42
42
:::caution Authentication and configuration requirements:
43
43
-**With classic PAT**:
44
-
- Specify organizations in PortMapping: `organizations: ["org1", "org2", "org3"]`
45
-
-**With GitHub App**: Specify exactly one organization: `githubOrganization: "my-org"`
46
-
-**With Fine-grained PAT**: Specify exactly one organization: `githubOrganization: "my-org"`
44
+
- Specify organizations in port mapping: `organizations: ["org1", "org2", "org3"]`
45
+
-**With GitHub App or Fine-grained PAT**: Specify exactly one organization by setting the `githubOrganization` in the environment variables: `githubOrganization: "my-org"`
47
46
48
-
**Precedence:** If `githubOrganization` is set in the deployment config and `organizations` are also listed in Port mapping, the integration prioritizes single‑organization behavior and syncs only the `githubOrganization`.
47
+
**Precedence:** If `githubOrganization` is set in the environment variables or config and `organizations` are also listed in port mapping, the integration prioritizes single‑organization behavior and syncs only the `githubOrganization`.
49
48
50
49
**Performance consideration:** Syncing multiple organizations will increase the number of API calls to GitHub and may slow down the integration. The more organizations you sync, the longer the resync time and the higher the API rate limit consumption. Consider syncing only the organizations you need.
51
50
:::
@@ -215,7 +214,7 @@ For example, say you want to manage your `package.json` files in Port. One optio
215
214
The following configuration fetches all `package.json` files from "MyRepo" and "MyOtherRepo", and creates an entity for each of them, based on the `manifest` blueprint:
216
215
217
216
:::info Organization field in file selectors
218
-
The `organization` field is optional when `githubOrganization` is set in the deployment config. It is required when no deployment-level organization is provided (e.g., Classic PAT with multiple organizations defined in your Port mapping).
217
+
The `organization` field is optional when `githubOrganization` is set in the environment variables and required when it is not provided (e.g., Classic PAT with multiple organizations defined in your port mapping).
Copy file name to clipboardExpand all lines: docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/installation/_install_methods.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -131,7 +131,7 @@ To install the integration using ArgoCD:
131
131
:::info Placeholder Replacement Required
132
132
Be sure to replace the `<GITHUB_TOKEN>` and `<GITHUB_ORGANIZATION>` placeholders with your actual values. If you are using a self-hosted GitHub instance, update the `githubHost` value to point to your instance.
133
133
134
-
For multi-organization support, use a **classic PAT token** and specify multiple organizations in the Port mapping
134
+
For multi-organization support, use a **classic PAT token** and specify multiple organizations in the port mapping
Copy file name to clipboardExpand all lines: docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/installation/installation.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,8 +32,8 @@ Starting from **version 3.0.0-beta**, the GitHub integration supports syncing da
32
32
33
33
:::info Multi-organization configuration
34
34
- GitHub App and fine-grained PAT: use `githubOrganization` (single organization).
35
-
- Classic PAT: to sync multiple organizations, list them in your Port mapping under `organizations`.
36
-
- Precedence: if `githubOrganization` is set in the deployment config and `organizations` are listed in Port mapping, the integration syncs only the `githubOrganization` (single‑org behavior).
35
+
- Classic PAT: to sync multiple organizations, list them in your port mapping under `organizations`.
36
+
- Precedence: if `githubOrganization` is set in the environment variables or config and `organizations` are listed in port mapping, the integration syncs only the `githubOrganization` (single‑org behavior).
37
37
- Performance: syncing multiple organizations increases API calls and may slow down the integration.
Copy file name to clipboardExpand all lines: docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/migration-guide.md
+6-7Lines changed: 6 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,11 +10,10 @@ The new Ocean-powered GitHub integration comes with several key improvements:
10
10
-**Enhanced performance** - Faster resyncs thanks to improved API efficiency, making your data available sooner.
11
11
-**Better selectors** - More granular control over what you sync with improved selectors for `pull requests`, `issues`, `dependabot alerts`, `codescanning alerts`, `files`, and `folders`.
12
12
13
-
## Major changes
14
13
15
-
### Multi-organization support (v3.0.0-beta)
14
+
### Multi-organization support
16
15
17
-
The GitHub integration now supports ingesting data from multiple GitHub organizations starting from **version 3.0.0-beta**. Configure one organization using `githubOrganization`, or list multiple organizations in your Port mapping under `organizations`:
16
+
The GitHub integration supports ingesting data from multiple GitHub organizations starting from **version 3.0.0-beta**. Configure one organization using `githubOrganization`, in your environment variables or list multiple organizations in your port mapping under `organizations`:
18
17
19
18
```yaml showLineNumbers
20
19
deleteDependentEntities: true
@@ -26,7 +25,7 @@ organizations:
26
25
# ... rest of your mapping (repositoryType, resources, etc.) ...
27
26
```
28
27
29
-
**Precedence:** If `githubOrganization` is set in the deployment config and `organizations` are listed in Port mapping, the integration syncs only the `githubOrganization` (single‑org behavior).
28
+
**Precedence:** If `githubOrganization` is set in the environment variables or config and `organizations` are listed in port mapping, the integration syncs only the `githubOrganization` (single‑org behavior).
30
29
31
30
### Authentication model
32
31
@@ -97,7 +96,7 @@ A key change is how we denote custom attributes. We now add a double underscore
97
96
### Files & GitOps
98
97
99
98
::::info Organization field in file selectors
100
-
The `organization` field is optional when `githubOrganization` is set in the deployment config. It is required when `githubOrganization` is not provided.
99
+
The `organization` field is optional when `githubOrganization` is set in the environment variables and it is required when not provided there.
101
100
::::
102
101
103
102
<details>
@@ -402,7 +401,7 @@ resources:
402
401
### Folders
403
402
404
403
::::info Organization field in folder selectors
405
-
The `organization` field is optional when `githubOrganization` is set in the deployment config. It is required when no deployment-level organization is provided (e.g., Classic PAT with multiple organizations defined in your Port mapping).
404
+
The `organization` field is optional when `githubOrganization` is set in the environment variables and is required when not provided (e.g., Classic PAT with multiple organizations defined in your port mapping).
406
405
::::
407
406
408
407
For the `folder` kind, the `folder.name` attribute is no longer part of the response. Instead, you can easily derive the folder name from the `folder.path` using a JQ expression, as shown in the example below:
@@ -552,7 +551,7 @@ This section provides a high-level summary of the key changes for mappings.
552
551
553
552
| Area | Old Value | New Value | Notes |
554
553
|---|---|---|---|
555
-
| **Multi-Organization** | N/A | `githubOrganization` is not optional | **Classic PAT supports multiple orgs using the `organization` parameter in Port mapping; GitHub App and Fine-grained PAT do not support multi organization and there required the `githubOrganization` configuration**. Syncing multiple organizations increases API calls and may slow down the integration. |
554
+
| **Multi-Organization** | N/A | `githubOrganization` is not optional | **Classic PAT supports multiple orgs using the `organization` parameter in port mapping; GitHub App and Fine-grained PAT do not support multi organization and there required the `githubOrganization` configuration**. Syncing multiple organizations increases API calls and may slow down the integration. |
556
555
| **File Organization** | N/A | `organization: "my-org"` | Optional if `githubOrganization` is set; required when not (e.g., Classic PAT multi-org). |
557
556
| **Folder Organization** | N/A | `organization: "my-org"` | Optional if `githubOrganization` is set; required when not set(e.g., Classic PAT multi-org). |
558
557
| **Authentication** | GitHub App Installation | PAT or Self-Created GitHub App | The integration can be authenticated using a Personal Access Token (PAT) or a self-created GitHub App. **Multi-org requires classic PAT**. |
0 commit comments