backstage/.changeset/tame-ads-exercise.md at a0f0b8eb9a6d570e7483bf10526e281f9ad4533d

Files

T

Mikko Korhonen 2e8764b95f chore(catalog-import): add change set for import flow customizations

Signed-off-by: Mikko Korhonen <mikko.korhonen@gmail.com>

2022-01-28 10:13:42 +02:00

1.2 KiB

Raw Blame History

@backstage/plugin-catalog-import

@backstage/plugin-catalog-import
minor

Make filename, branch name and examples URLs used in catalog import customizable.

Catalog backend ingestion loop can be already configured to fetch targets with custom catalog filename (other than catalog-info.yaml). It's now possible to customize said filename and branch name used in pull requests created by catalog import flow too. This allows organizations to further customize Backstage experience and to better reflect their branding.

Filename (default: catalog-info.yaml) and branch name (default: backstage-integration) used in pull requests can be configured in app-config.yaml as follows:

// app-config.yaml

catalog:
  import:
    entityFilename: anvil.yaml
    pullRequestBranchName: anvil-integration

Following React components have also been updated to accept optional props for providing example entity and repository paths:

<StepInitAnalyzeUrl
  ...
  exampleLocationUrl="https://github.com/acme-corp/our-awesome-api/blob/main/anvil.yaml"
/>

<ImportInfoCard
  exampleLocationUrl="https://github.com/acme-corp/our-awesome-api/blob/main/anvil.yaml"
  exampleRepositoryUrl="https://github.com/acme-corp/our-awesome-api"
/>

1.2 KiB Raw Blame History

1.2 KiB

Raw Blame History