Skip to content

Commit bd7da11

Browse files
authored
Merge branch 'main' into PORT-trigger-gemini
2 parents 7702cb3 + 536d385 commit bd7da11

File tree

13 files changed

+1041
-7
lines changed

13 files changed

+1041
-7
lines changed

docs/build-your-software-catalog/sync-data-to-catalog/git/azure-devops/advanced.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,10 @@ The following advanced configuration parameters are available and can be added t
3434

3535
<TabItem label="Spec path" value="specPath">
3636

37+
:::warning Deprecated parameter
38+
The `specPath` parameter is deprecated. We recommend using the [file kind](https://docs.port.io/build-your-software-catalog/sync-data-to-catalog/git/azure-devops/#ingest-files-from-your-repositories) for GitOps instead, which provides more flexible file ingestion capabilities.
39+
:::
40+
3741
The `specPath` parameter specifies a list of `string` or a single value `string` that Port's Azure Devops app will search for `port.yml` files in.
3842

3943
- **Default value**: `port.yml`
@@ -72,12 +76,16 @@ The `createMissingRelatedEntities` parameter is used to enable the creation of m
7276

7377
<TabItem value="branch" label="Branch">
7478

79+
:::warning Deprecated parameter
80+
The `branch` parameter is deprecated. We recommend using the [file kind](https://docs.port.io/build-your-software-catalog/sync-data-to-catalog/git/azure-devops/#ingest-files-from-your-repositories) for GitOps instead, which provides more flexible file ingestion capabilities.
81+
:::
82+
7583
The Azure Devops integration listens to real-time events from the branch specified in the `branch` field which is set to `main` by default. This is configurable and you can set the `branch` parameter to the branch you want to listen to events from.
7684

7785
- **Default value**: `main` (default to the branch specified in the `branch` field.)
7886
- **Use case**: `develop` if you want to listen to events from the `develop` branch of the repository.
7987

80-
:::note Use Default Branch
88+
:::info Use default branch
8189

8290
If you want to listen to events from the default branch of the repository, you can set the `useDefaultBranch` parameter to `true`.
8391

docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-collaborators/_github_exporter_example_repository_collaborator_port_app_config.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ resources:
88
- kind: repository
99
selector:
1010
query: "true" # JQ boolean query. If evaluated to false - skip syncing the object.
11+
include: ["collaborators"] # Include collaborators as a relationship
1112
port:
1213
entity:
1314
mappings:

docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-teams/_github_exporter_example_repository_with_teams_port_app_config.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ resources:
2525
- kind: repository
2626
selector:
2727
query: "true" # JQ boolean query. If evaluated to false - skip syncing the object.
28-
include: "teams" # Boolean flag to indicate whether to include the repository teams.
28+
include: ["teams"] # List of relationship types to include. Can include multiple types like ["teams", "collaborators"].
2929
port:
3030
entity:
3131
mappings:

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

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,50 @@ You can use the following Port blueprint definitions and `port-app-config.yml`:
199199
<PortRepositoryTeamMappingAppConfig/>
200200

201201

202+
## Map repositories with multiple relationships
203+
204+
You can now include multiple relationship types in a single repository configuration. For example, to include both teams and collaborators:
205+
206+
```yaml showLineNumbers
207+
- kind: repository
208+
selector:
209+
query: "true"
210+
include: ["teams", "collaborators"] # Include both teams and collaborators
211+
port:
212+
entity:
213+
mappings:
214+
identifier: .name
215+
title: .name
216+
blueprint: '"githubRepository"'
217+
properties:
218+
readme: file://README.md
219+
url: .html_url
220+
defaultBranch: .default_branch
221+
relations:
222+
githubTeams: "[.__teams[].id | tostring]"
223+
githubCollaborators: "[.__collaborators[].login]"
224+
```
225+
226+
:::caution Performance consideration
227+
While you can include multiple relationship types in a single configuration, this may impact resync performance for large repositories. For optimal performance, consider separating into multiple repository blocks:
228+
229+
```yaml showLineNumbers
230+
# Separate blocks for better performance
231+
- kind: repository
232+
selector:
233+
query: "true"
234+
include: ["teams"]
235+
# ... rest of configuration
236+
237+
- kind: repository
238+
selector:
239+
query: "true"
240+
include: ["collaborators"]
241+
# ... rest of configuration
242+
```
243+
:::
244+
245+
202246
## Map teams and team members
203247

204248
The following shows how we can map teams and team members using the "members" selector.

0 commit comments

Comments
 (0)