diff --git a/.changeset/fresh-schools-fly.md b/.changeset/fresh-schools-fly.md index bde325b574..e364e08d43 100644 --- a/.changeset/fresh-schools-fly.md +++ b/.changeset/fresh-schools-fly.md @@ -2,7 +2,7 @@ '@backstage/plugin-catalog-backend-module-gitlab': minor --- -The configuration of the `GitlabDiscoveryEntityProvider` has changed as follows: +**BREAKING**: The configuration of the `GitlabDiscoveryEntityProvider` has changed as follows: - The configuration key `branch` is now used to define the branch from which the catalog-info should be discovered. - The old configuration key `branch` is now called `fallbackBranch`. This value specifies which branch should be used diff --git a/docs/integrations/gitlab/discovery.md b/docs/integrations/gitlab/discovery.md index 48383c4275..45991b2cf5 100644 --- a/docs/integrations/gitlab/discovery.md +++ b/docs/integrations/gitlab/discovery.md @@ -21,7 +21,7 @@ catalog: gitlab: yourProviderId: host: gitlab-host # Identifies one of the hosts set up in the integrations - branch: main # Optional. Used to discover on a concrete branch + branch: main # Optional. Used to discover on a specific branch fallbackBranch: main # 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 group: example-group # Optional. Group and subgroup (if needed) to look for repositories. If not present the whole instance will be scanned entityFilename: catalog-info.yaml # Optional. Defaults to `catalog-info.yaml`