Skip to content

Commit

Permalink
chore(catalog-import): add change set for import flow customizations
Browse files Browse the repository at this point in the history
Signed-off-by: Mikko Korhonen <mikko.korhonen@gmail.com>
  • Loading branch information
kmikko committed Jan 28, 2022
1 parent b40159f commit 2e8764b
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .changeset/tame-ads-exercise.md
@@ -0,0 +1,34 @@
---
'@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:

```yaml
// 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:

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

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

0 comments on commit 2e8764b

Please sign in to comment.