Merge pull request backstage#3921 from goober/feature/catalog-import-…

…descriptions

catalog-import: add support for multiple git providers

.changeset/generic-catalog-import-descriptions.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-catalog-import': patch
+---
+
+Add more generic descriptions for the catalog-import form.

plugins/catalog-import/src/components/ImportComponentForm.tsx

@@ -46,9 +46,14 @@ const useStyles = makeStyles<BackstageTheme>(theme => ({
 type Props = {
   nextStep: () => void;
   saveConfig: (configFile: ConfigSpec) => void;
+  repository: string;
 };
 
-export const RegisterComponentForm = ({ nextStep, saveConfig }: Props) => {
+export const RegisterComponentForm = ({
+  nextStep,
+  saveConfig,
+  repository,
+}: Props) => {
   const { register, handleSubmit, errors, formState } = useForm({
     mode: 'onChange',
   });
@@ -103,7 +108,7 @@ export const RegisterComponentForm = ({ nextStep, saveConfig }: Props) => {
           name="componentLocation"
           required
           margin="normal"
-          helperText="Enter the full path to the repository in GitHub to start tracking your component."
+          helperText={`Enter the full path to the repository in ${repository} to start tracking your component.`}
           inputRef={register({
             required: true,
             validate: ComponentIdValidators,

plugins/catalog-import/src/components/ImportComponentPage.tsx

@@ -24,6 +24,9 @@ import {
   SupportButton,
   ContentHeader,
   RouteRef,
+  useApi,
+  configApiRef,
+  ConfigApi,
 } from '@backstage/core';
 import { RegisterComponentForm } from './ImportComponentForm';
 import ImportStepper from './ImportStepper';
@@ -37,6 +40,28 @@ export type ConfigSpec = {
   config: PartialEntity[];
 };
 
+function manifestGenerationAvailable(configApi: ConfigApi): boolean {
+  return configApi.has('integrations.github');
+}
+
+function repositories(configApi: ConfigApi): string[] {
+  const integrations = configApi.getConfig('integrations');
+  const repositories = [];
+  if (integrations.has('github')) {
+    repositories.push('GitHub');
+  }
+  if (integrations.has('bitbucket')) {
+    repositories.push('Bitbucket');
+  }
+  if (integrations.has('gitlab')) {
+    repositories.push('GitLab');
+  }
+  if (integrations.has('azure')) {
+    repositories.push('Azure');
+  }
+  return repositories;
+}
+
 export const ImportComponentPage = ({
   catalogRouteRef,
 }: {
@@ -53,13 +78,17 @@ export const ImportComponentPage = ({
     setActiveStep(step => (options?.reset ? 0 : step + 1));
   };
 
+  const configApi = useApi(configApiRef);
+  const appTitle = configApi.getOptional('app.title') || 'Backstage';
+  const repos = repositories(configApi);
+  const repositoryString = repos.join(', ').replace(/, (\w*)$/, ' or $1');
   return (
     <Page themeId="home">
       <Header title="Register an existing component" />
       <Content>
-        <ContentHeader title="Start tracking your component in Backstage">
+        <ContentHeader title={`Start tracking your component in ${appTitle}`}>
           <SupportButton>
-            Start tracking your component in Backstage by adding it to the
+            Start tracking your component in {appTitle} by adding it to the
             software catalog.
           </SupportButton>
         </ContentHeader>
@@ -73,21 +102,28 @@ export const ImportComponentPage = ({
               }}
             >
               <Typography variant="body2" paragraph>
-                There are two ways to register an existing component.
-              </Typography>
-              <Typography variant="h6">GitHub Repo</Typography>
-              <Typography variant="body2" paragraph>
-                If you already have code in a GitHub repository, enter the full
-                URL to your repo and a new pull request with a sample Backstage
-                metadata Entity File (<code>catalog-info.yaml</code>) will be
-                opened for you.
+                Ways to register an existing component
               </Typography>
+
+              {manifestGenerationAvailable(configApi) && (
+                <React.Fragment>
+                  <Typography variant="h6">GitHub Repo</Typography>
+                  <Typography variant="body2" paragraph>
+                    If you already have code in a GitHub repository, enter the
+                    full URL to your repo and a new pull request with a sample
+                    Backstage metadata Entity File (
+                    <code>catalog-info.yaml</code>) will be opened for you.
+                  </Typography>
+                </React.Fragment>
+              )}
               <Typography variant="h6">
-                GitHub Repo &amp; Entity File
+                {repos.length === 1 ? `${repos[0]} ` : ''} Repository &amp;
+                Entity File
               </Typography>
               <Typography variant="body2" paragraph>
-                If you've already created a Backstage metadata file and put it
-                in your repo, you can enter the full URL to that Entity File.
+                If you've already created a {appTitle} metadata file and put it
+                in your {repositoryString} repository, you can enter the full
+                URL to that Entity File.
               </Typography>
             </InfoCard>
           </Grid>
@@ -96,11 +132,14 @@ export const ImportComponentPage = ({
               <ImportStepper
                 steps={[
                   {
-                    step: 'Insert GitHub repo URL or Entity File URL',
+                    step: manifestGenerationAvailable(configApi)
+                      ? 'Insert GitHub repo URL or Entity File URL'
+                      : 'Insert Entity File URL',
                     content: (
                       <RegisterComponentForm
                         nextStep={nextStep}
                         saveConfig={setConfigFile}
+                        repository={repositoryString}
                       />
                     ),
                   },