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/gitlab-v2/examples.md
+34-17Lines changed: 34 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,13 +28,18 @@ import ReleaseBlueprint from './example-releases/_gitlab_integration_example_rel
28
28
import ReleaseConfig from './example-releases/_gitlab_integration_example_release_config.mdx'
29
29
import TagBlueprint from './example-tags/_gitlab_integration_example_tag_blueprint.mdx'
30
30
import TagConfig from './example-tags/_gitlab_integration_example_tag_config.mdx'
31
+
import TeamBlueprint from './example-files/_gitlab_integration_example_team_blueprint.mdx'
32
+
import YamlConfig from './example-files/_gitlab_integration_example_yaml_config.mdx'
33
+
import TeamsYamlFileExample from './example-files/_gitlab_integration_example_team_yaml_file_example.mdx'
31
34
32
35
import Tabs from "@theme/Tabs"
33
36
import TabItem from "@theme/TabItem"
34
37
35
38
# Examples
36
39
37
-
## Mapping groups
40
+
## Mapping examples
41
+
42
+
### Groups
38
43
39
44
The following example demonstrates how to ingest your GitLab groups, subgroups and projects to Port.
40
45
You can use the following Port blueprint definitions and integration configuration:
@@ -56,7 +61,7 @@ You can use the following Port blueprint definitions and integration configurati
56
61
57
62
58
63
59
-
##Mapping projects, README.md and merge requests
64
+
### Projects, README.md and merge requests
60
65
61
66
:::caution Merge request access requirement
62
67
Merge requests are fetched at the **group level**. Ensure your integration token has access to the parent GitLab group that contains your projects. Project-level access alone is not sufficient for merge request visibility.
@@ -75,7 +80,7 @@ You can use the following Port blueprint definitions and integration configurati
75
80
76
81
<MergeRequestConfig />
77
82
78
-
### Merge request configuration options
83
+
####Merge request configuration options
79
84
80
85
<TabsgroupId="config"queryString="parameter">
81
86
@@ -133,7 +138,7 @@ By default, if not specified, it is set to `90` days.
133
138
134
139
135
140
136
-
## Mapping projects and issues
141
+
### Projects and issues
137
142
138
143
The following example demonstrates how to ingest your GitLab projects and their issues to Port.
139
144
You can use the following Port blueprint definitions and integration configuration:
@@ -155,7 +160,9 @@ You can use the following Port blueprint definitions and integration configurati
155
160
156
161
157
162
158
-
## Mapping files and file contents
163
+
### Files and file contents
164
+
165
+
Below are two examples for mapping files and contents:
159
166
160
167
The following example shows how to ingest dependencies from a `package.json` file in your GitLab repository into Port.
161
168
You can use the following Port blueprint definitions and integration configuration:
@@ -164,13 +171,23 @@ You can use the following Port blueprint definitions and integration configurati
164
171
165
172
<PackageConfig />
166
173
167
-
The integration mapping example above demonstrates both a JSON file (`package.json`) and a YAML file (`config.yml`) configuration.
168
-
The example will parse the file in your repository and extract the dependencies into Port entities.
169
-
For more information about ingesting files and file contents, click [here](/build-your-software-catalog/sync-data-to-catalog/git/gitlab-v2/#ingest-files-from-your-repositories).
174
+
The example will parse the `package.json` file in your repository and extract the dependencies into Port entities.
175
+
176
+
___
177
+
178
+
The following example shows how to ingest teams from a YAML file in your GitLab repository into Port.
170
179
180
+
<TeamBlueprint/>
171
181
182
+
<YamlConfig/>
183
+
184
+
<TeamsYamlFileExample/>
185
+
186
+
The example will parse the YAML file in your repository and extract the teams into Port entities.
187
+
188
+
For more information about ingesting files and file contents, click [here](/build-your-software-catalog/sync-data-to-catalog/git/gitlab-v2/#ingest-files-from-your-repositories).
172
189
173
-
## Mapping projects and monorepos
190
+
### Projects and monorepos
174
191
175
192
The following example demonstrates how to ingest your GitLab projects and their monorepo folders to Port.
176
193
You can use the following Port blueprint definitions and integration configuration:
@@ -219,7 +236,7 @@ You can also specify a different path for each monorepo repository, for example:
219
236
220
237
221
238
222
-
## Mapping projects and folders
239
+
### Projects and folders
223
240
224
241
The following example demonstrates how to ingest your GitLab projects and their folders to Port.
225
242
You can use the following Port blueprint definitions and integration configuration:
@@ -248,9 +265,9 @@ resources:
248
265
```
249
266
:::
250
267
251
-
## Mapping members and group with members
268
+
### Mapping members and group with members
252
269
253
-
### Prerequisites
270
+
#### Prerequisites
254
271
255
272
- When using **GitLab Self Hosted**, an admin token is required, rather than a group access token, to retrieve the `primary email addresses` of members.
256
273
- When using **GitLab Enterprise**, accounts can retrieve the `primary email addresses` of members within their groups, provided the members are part of user accounts administered by an organization with [verified domains for groups](https://docs.gitlab.com/ee/user/enterprise_user/#verified-domains-for-groups). For more information, see [limitations](https://docs.gitlab.com/ee/api/members.html#limitations).
@@ -259,7 +276,7 @@ resources:
259
276
Primary email addresses are not available for GitLab "Free plan" users.
260
277
:::
261
278
262
-
### Mapping members
279
+
#### Mapping members
263
280
264
281
The following example demonstrates how to ingest your GitLab members to Port.
265
282
You can use the following Port blueprint definitions and integration configuration:
@@ -270,7 +287,7 @@ You can use the following Port blueprint definitions and integration configurati
270
287
271
288
272
289
273
-
### Mapping groups with members
290
+
#### Mapping groups with members
274
291
275
292
The following example demonstrates how to ingest your GitLab groups and their members to Port.
276
293
You can use the following Port blueprint definitions and integration configuration:
@@ -315,7 +332,7 @@ By default, this selector is set to `false`, which means the integration will on
315
332
:::
316
333
317
334
318
-
## Mapping projects, pipelines and jobs
335
+
### Projects, pipelines and jobs
319
336
320
337
The following example demonstrates how to ingest your GitLab projects, their pipelines and jobs runs to Port.
321
338
You can use the following Port blueprint definitions and integration configuration:
@@ -336,7 +353,7 @@ You can use the following Port blueprint definitions and integration configurati
336
353
337
354
:::
338
355
339
-
## Mapping releases
356
+
### Releases
340
357
341
358
The following example demonstrates how to ingest your GitLab releases to Port.
342
359
You can use the following Port blueprint definitions and integration configuration:
@@ -353,7 +370,7 @@ You can use the following Port blueprint definitions and integration configurati
353
370
354
371
:::
355
372
356
-
## Mapping tags
373
+
## Tags
357
374
358
375
The following example demonstrates how to ingest your GitLab tags to Port.
359
376
You can use the following Port blueprint definitions and integration configuration:
0 commit comments