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
+11-1Lines changed: 11 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -87,7 +87,7 @@ When configuring the integration **using Port**, the YAML configuration is globa
87
87
The `repositoryType` parameter filters which repositories are ingested. It corresponds to the `type` parameter in GitHub's [List organization repositories](https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#list-organization-repositories) API.
88
88
89
89
<details>
90
-
<summary>Possible values:</summary>
90
+
<summary><b>Possible values (Click to expand)</b></summary>
91
91
92
92
*`all` (default): All repositories accessible to the provided token.
93
93
*`public`: Public repositories.
@@ -218,6 +218,8 @@ The following configuration fetches all `package.json` files from "MyRepo" and "
218
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).
219
219
:::
220
220
221
+
<details>
222
+
<summary><b>Package file mapping example (click to expand)</b></summary>
221
223
```yaml showLineNumbers
222
224
resources:
223
225
- kind: file
@@ -244,6 +246,8 @@ resources:
244
246
project_version: .content.version
245
247
license: .content.license
246
248
```
249
+
</details>
250
+
247
251
248
252
:::tip Test your mapping
249
253
After adding the `file` kind to your mapping configuration, click on the `Resync` button. When you open the mapping configuration again, you will see real examples of files fetched from your GitHub organization.
@@ -743,6 +747,8 @@ For example, say you want to track/manage a project's dependencies in Port. One
743
747
744
748
The following configuration fetches a `package.json` file from a specific repository, and creates an entity for each of the dependencies in the file, based on the `package` blueprint:
745
749
750
+
<details>
751
+
<summary><b>File mapping example for mulitiple entities (click to expand)</b></summary>
746
752
```yaml showLineNumbers
747
753
resources:
748
754
- kind: file
@@ -770,6 +776,7 @@ resources:
770
776
version: .item.value
771
777
relations: {}
772
778
```
779
+
</details>
773
780
774
781
#### Multi-document YAML files
775
782
@@ -798,6 +805,8 @@ When `skipParsing` is set to `true`, the file content will be kept in its origin
798
805
799
806
Here's an example that ingests the raw content of a `values.yaml` file into the `content` property of a `file` entity:
800
807
808
+
<details>
809
+
<summary><b>File mapping example for ingesting raw content (click to expand)</b></summary>
0 commit comments