diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/git/gitlab-v2/examples.md b/docs/build-your-software-catalog/sync-data-to-catalog/git/gitlab-v2/examples.md index cb4fc60851..b1193ca1be 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/git/gitlab-v2/examples.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/git/gitlab-v2/examples.md @@ -50,6 +50,18 @@ You can use the following Port blueprint definitions and integration configurati +#### Group configuration options + +The `includeOnlyActiveGroups` selector allows you to filter groups based on whether they are active or not. +By default, if not specified, all groups will be synced. + +```yaml showLineNumbers +- kind: group + selector: + query: 'true' + # highlight-next-line + includeOnlyActiveGroups: true +``` :::tip Learn more @@ -80,6 +92,19 @@ You can use the following Port blueprint definitions and integration configurati +#### Project configuration options + +The `includeOnlyActiveProjects` selector allows you to filter projects based on whether they are active or not. +By default, if not specified, all projects will be synced. + +```yaml showLineNumbers +- kind: project + selector: + query: 'true' + # highlight-next-line + includeOnlyActiveProjects: true +``` + #### Merge request configuration options @@ -127,6 +152,20 @@ By default, if not specified, it is set to `90` days. ``` + + +The `includeOnlyActiveGroups` selector allows you to filter merge requests based on whether the parent group is active or not. +By default, if not specified, all merge requests for the authorized groups will be synced. + +```yaml + - kind: merge-request + selector: + query: 'true' + # highlight-next-line + includeOnlyActiveGroups: true +``` + + :::tip Learn more @@ -149,6 +188,119 @@ You can use the following Port blueprint definitions and integration configurati +#### Issues configuration options + + + + + +The `state` selector allows you to filter issues based on their state. You can specify one of the allowed values to include in the sync. + +Allowed values: +- `opened`: Issues that are currently open. +- `closed`: Issues that have been closed. + +By default, if not specified, all issues for the authorized groups will be synced. + +```yaml showLineNumbers +- kind: issue + selector: + query: 'true' + # highlight-next-line + state: "closed" +``` + + + + +The `updatedAfter` selector allows you to filter issues based on when they were last updated. This helps you focus on recent changes and reduce the amount of historical data being synced. + +The value represents the number of days to look back for issues. For example, setting it to `90` will only sync issues that have been updated on or after the last 90 days. + +:::info Important +The `updatedAfter` parameter only affects issues that are not in the "opened" state. Open issues will always be synced regardless of their last update time. +::: + +By default, if not specified, all issues for the authorized groups will be synced. + +```yaml showLineNumbers + - kind: issue + selector: + query: 'true' + # highlight-next-line + updatedAfter: 90 +``` + + + + +The `includeOnlyActiveGroups` selector allows you to filter issues based on whether the parent group is active or not. +By default, if not specified, all issues for the authorized groups will be synced. + +```yaml + - kind: issue + selector: + query: 'true' + # highlight-next-line + includeOnlyActiveGroups: true +``` + + + + +The `issueType` selector allows you to filter issues based on their type. + +Allowed values: +- `incident` +- `issue` +- `test_case` +- `task` + +By default, if not specified, all issues for the authorized groups will be synced. + +```yaml + - kind: issue + selector: + query: 'true' + # highlight-next-line + issueType: "incident" +``` + + + + +The `labels` selector allows you to filter issues based on a comma-separated list of labels. +By default, if not specified, all issues for the authorized groups will be synced. + +:::info Important +Issue must have **all labels** to be returned. +::: + +```yaml + - kind: issue + selector: + query: 'true' + # highlight-next-line + labels: "dev,v1" +``` + + + + +The `includeNonArchived` selector allows you to filter issues from non-archived projects. +By default, if not specified, all issues for the authorized groups will be synced. + + +```yaml + - kind: issue + selector: + query: 'true' + # highlight-next-line + nonArchived: true +``` + + + :::tip Learn more @@ -285,7 +437,15 @@ You can use the following Port blueprint definitions and integration configurati +To retrieve the members of your **active groups** only, you can use the following syntax in your `port-app-config.yml`: +```yaml showLineNumbers +- kind: member + selector: + query: "true" + # highlight-next-line + includeOnlyActiveGroups: true +``` #### Mapping groups with members @@ -366,6 +526,26 @@ You can use the following Port blueprint definitions and integration configurati +To retrieve the pipelines of your **active projects** only, you can use the following syntax in your `port-app-config.yml`: + +```yaml showLineNumbers +- kind: pipeline + selector: + query: "true" + # highlight-next-line + includeOnlyActiveProjects: true +``` + +To retrieve the jobs of your **active projects** only, you can use the following syntax in your `port-app-config.yml`: + +```yaml showLineNumbers +- kind: job + selector: + query: "true" + # highlight-next-line + includeOnlyActiveProjects: true +``` + :::tip Learn more - Refer to the [setup](/build-your-software-catalog/sync-data-to-catalog/git/gitlab-v2/#setup) section to learn more about the integration configuration setup process. @@ -385,6 +565,16 @@ You can use the following Port blueprint definitions and integration configurati +To retrieve the releases of your **active projects** only, you can use the following syntax in your `port-app-config.yml`: + +```yaml showLineNumbers +- kind: release + selector: + query: "true" + # highlight-next-line + includeOnlyActiveProjects: true +``` + :::tip Learn more - Refer to the [setup](/build-your-software-catalog/sync-data-to-catalog/git/gitlab-v2/#setup) section to learn more about the integration configuration setup process. @@ -402,6 +592,16 @@ You can use the following Port blueprint definitions and integration configurati +To retrieve the tags of your **active projects** only, you can use the following syntax in your `port-app-config.yml`: + +```yaml showLineNumbers +- kind: tag + selector: + query: "true" + # highlight-next-line + includeOnlyActiveProjects: true +``` + :::tip Learn more - Refer to the [setup](/build-your-software-catalog/sync-data-to-catalog/git/gitlab-v2/#setup) section to learn more about the integration configuration setup process.