Skip to content

Commit da38077

Browse files
committed
fix: handle pr reviews
1 parent 86e5e9e commit da38077

File tree

4 files changed

+14
-16
lines changed

4 files changed

+14
-16
lines changed

docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/github-ocean.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Here's what you can do with the GitHub integration:
2222

2323
### Multi-organization support
2424

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`).
2626

2727
<details>
2828
<summary><b>Mapping multi organizations (Click to expand)</b></summary>
@@ -41,11 +41,10 @@ organizations:
4141

4242
:::caution Authentication and configuration requirements:
4343
- **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"`
4746

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`.
4948

5049
**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.
5150
:::
@@ -215,7 +214,7 @@ For example, say you want to manage your `package.json` files in Port. One optio
215214
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:
216215

217216
:::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).
219218
:::
220219

221220
<details>

docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/installation/_install_methods.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ To install the integration using ArgoCD:
131131
:::info Placeholder Replacement Required
132132
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.
133133

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
135135

136136
```yaml showLineNumbers
137137
deleteDependentEntities: true

docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/installation/installation.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ Starting from **version 3.0.0-beta**, the GitHub integration supports syncing da
3232

3333
:::info Multi-organization configuration
3434
- 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).
3737
- Performance: syncing multiple organizations increases API calls and may slow down the integration.
3838
:::
3939

docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/migration-guide.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,10 @@ The new Ocean-powered GitHub integration comes with several key improvements:
1010
- **Enhanced performance** - Faster resyncs thanks to improved API efficiency, making your data available sooner.
1111
- **Better selectors** - More granular control over what you sync with improved selectors for `pull requests`, `issues`, `dependabot alerts`, `codescanning alerts`, `files`, and `folders`.
1212

13-
## Major changes
1413

15-
### Multi-organization support (v3.0.0-beta)
14+
### Multi-organization support
1615

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`:
1817

1918
```yaml showLineNumbers
2019
deleteDependentEntities: true
@@ -26,7 +25,7 @@ organizations:
2625
# ... rest of your mapping (repositoryType, resources, etc.) ...
2726
```
2827

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).
3029

3130
### Authentication model
3231

@@ -97,7 +96,7 @@ A key change is how we denote custom attributes. We now add a double underscore
9796
### Files & GitOps
9897

9998
::::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.
101100
::::
102101

103102
<details>
@@ -402,7 +401,7 @@ resources:
402401
### Folders
403402

404403
::::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).
406405
::::
407406

408407
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.
552551

553552
| Area | Old Value | New Value | Notes |
554553
|---|---|---|---|
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. |
556555
| **File Organization** | N/A | `organization: "my-org"` | Optional if `githubOrganization` is set; required when not (e.g., Classic PAT multi-org). |
557556
| **Folder Organization** | N/A | `organization: "my-org"` | Optional if `githubOrganization` is set; required when not set(e.g., Classic PAT multi-org). |
558557
| **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

Comments
 (0)