diff --git a/app-config.yaml b/app-config.yaml index 38efb3bb87..b84b5de2f2 100644 --- a/app-config.yaml +++ b/app-config.yaml @@ -196,6 +196,7 @@ integrations: catalog: import: entityFilename: catalog-info.yaml + pullRequestBranchName: backstage-integration rules: - allow: - Component diff --git a/packages/create-app/templates/default-app/app-config.yaml.hbs b/packages/create-app/templates/default-app/app-config.yaml.hbs index 380c7c5152..46e2ecbb05 100644 --- a/packages/create-app/templates/default-app/app-config.yaml.hbs +++ b/packages/create-app/templates/default-app/app-config.yaml.hbs @@ -82,6 +82,7 @@ scaffolder: catalog: import: entityFilename: catalog-info.yaml + pullRequestBranchName: backstage-integration rules: - allow: [Component, System, API, Group, User, Resource, Location] locations: diff --git a/plugins/catalog-import/config.d.ts b/plugins/catalog-import/config.d.ts index b5c5edb89a..0cc49e418b 100644 --- a/plugins/catalog-import/config.d.ts +++ b/plugins/catalog-import/config.d.ts @@ -28,6 +28,13 @@ export interface Config { * @visibility frontend */ entityFilename?: string; + /** + * A branch name used in pull request when registering existing component via UI + * Valid git refname required, see: https://git-scm.com/docs/git-check-ref-format + * Defaults to "backstage-integration" + * @visibility frontend + */ + pullRequestBranchName?: string; }; }; } diff --git a/plugins/catalog-import/src/api/CatalogImportClient.ts b/plugins/catalog-import/src/api/CatalogImportClient.ts index 1b84fba12f..218814d2fb 100644 --- a/plugins/catalog-import/src/api/CatalogImportClient.ts +++ b/plugins/catalog-import/src/api/CatalogImportClient.ts @@ -303,7 +303,9 @@ the component will become available.\n\nFor more information, read an \ baseUrl: githubIntegrationConfig.apiBaseUrl, }); - const branchName = 'backstage-integration'; + const branchName = + this.configApi.getOptionalString('catalog.pullRequestBranchName') ?? + 'backstage-integration'; const fileName = this.configApi.getOptionalString('catalog.import.entityFilename') ?? 'catalog-info.yaml';