Performing a sync with your GitHub for your catalog files
Published on August 23rd, 2022Introduction
Roadie can perform on demand syncs with your organisation. This is useful in a case where you already have catalog-info.yaml
files distributed in your organization and you’d like Roadie to pick them up.
Prerequisites
- You must have installed the Roadie GitHub app in your organisation as described here
- You must be an Admin of Roadie Backstage, as described here.
Steps
- Visit the Administration > Settings page and click on GitHub under Integrations
- Scroll down to the
Import Existing Components
section. - Press the
IMPORT
button in the bottom left corner. - A modal will open up.
- Type the target url that you used in your
app-config.yaml
files under thecatalog.locations
key with the type: github-discovery. - Press the
IMPORT
button in the bottom right corner - You can see a table with all of the discovered repos that got added to the roadie catalog.
Confirming it worked
You can go to the catalog and see your added components.