Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(catalog-import): add change set for import flow customizations
Signed-off-by: Mikko Korhonen <mikko.korhonen@gmail.com>
- Loading branch information
Showing
1 changed file
with
34 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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" | ||
/> | ||
``` |