paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 24 Packages Projects Releases Wiki Activity

enhance gitlab discovery to use group search API (#31993)

Browse Source 
* feat(gitlab): update discovery by allowing API search

instead of parsing groups/subgroups this change allows to use
the dedicated gitlab search API https://docs.gitlab.com/api/search/#scope-blobs.

this API is restricted to 'Premium' and 'Ultimate' gitlab client.

Signed-off-by: Matthieu Brouillard <m.brouillard@lectra.com>

* tests(gitlab): add tests for entity discovery by search API

Signed-off-by: Matthieu Brouillard <m.brouillard@lectra.com>

* docs(gitlab): update discovery documentation to add 'useSearch' configuration parameter

Signed-off-by: Matthieu Brouillard <m.brouillard@lectra.com>

* docs(gitlab): update report api

Signed-off-by: Matthieu Brouillard <m.brouillard@lectra.com>

* docs(gitlab): add generated changeset

Signed-off-by: Matthieu Brouillard <m.brouillard@lectra.com>

* fix(gitlab): use parameter 'filename:' in group search

Signed-off-by: Matthieu Brouillard <m.brouillard@lectra.com>

---------

Signed-off-by: Matthieu Brouillard <m.brouillard@lectra.com>
This commit is contained in:
Matthieu Brouillard
2026-02-03 15:02:08 +01:00
committed by GitHub
parent 1f20b9f6a7
commit 2f51676452
11 changed files with 381 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/integrations/gitlab/discovery.md
+2 -1
View File
@@ -154,11 +154,12 @@ catalog:
fallbackBranch: master # Optional. Fallback to be used if there is no default branch configured at the Gitlab repository. It is only used, if `branch` is undefined. Uses `master` as default
skipForkedRepos: false # Optional. If the project is a fork, skip repository
includeArchivedRepos: false # Optional. If project is archived, include repository
group: example-group # Optional. Group and subgroup (if needed) to look for repositories. If not present the whole instance will be scanned
group: example-group # Optional (unless useSearch is true). Group and subgroup (if needed) to look for repositories. If not present the whole instance will be scanned
groupPattern: # Optional. Filters for groups based on a list of RegEx. Default, no filters.
- '^somegroup$'
- 'anothergroup'
entityFilename: catalog-info.yaml # Optional. Defaults to `catalog-info.yaml`
useSearch: false # Optional. Whether to use the GitLab group search API to find files. Requires Gitlab 'Premium' or 'Ultimate' licenses. Defaults to `false`
projectPattern: '[\s\S]*' # Optional. Filters found projects based on provided pattern. Defaults to `[\s\S]*`, which means to not filter anything
excludeRepos: [] # Optional. A list of project paths that should be excluded from discovery, e.g. group/subgroup/repo. Should not start or end with a slash.
schedule: # Same options as in SchedulerServiceTaskScheduleDefinition. Optional for the Legacy Backend System