Merge pull request #3681 from adamdmharvey/pr-body

feat(catalog-import): Add instructions to Pull Request description when registering a new component

.changeset/loud-icons-itch.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-catalog-import': patch
+---
+
+Add description to Pull Request when registering a new component

plugins/catalog-import/src/api/CatalogImportClient.ts

@@ -15,7 +15,7 @@
  */
 
 import { Octokit } from '@octokit/rest';
-import { DiscoveryApi, OAuthApi } from '@backstage/core';
+import { DiscoveryApi, OAuthApi, ConfigApi } from '@backstage/core';
 import { CatalogImportApi } from './CatalogImportApi';
 import { AnalyzeLocationResponse } from '@backstage/plugin-catalog-backend';
 import { PartialEntity } from '../util/types';
@@ -24,13 +24,16 @@ import { GitHubIntegrationConfig } from '@backstage/integration';
 export class CatalogImportClient implements CatalogImportApi {
   private readonly discoveryApi: DiscoveryApi;
   private readonly githubAuthApi: OAuthApi;
+  private readonly configApi: ConfigApi;
 
   constructor(options: {
     discoveryApi: DiscoveryApi;
     githubAuthApi: OAuthApi;
+    configApi: ConfigApi;
   }) {
     this.discoveryApi = options.discoveryApi;
     this.githubAuthApi = options.githubAuthApi;
+    this.configApi = options.configApi;
   }
 
   async generateEntityDefinitions({
@@ -164,12 +167,23 @@ export class CatalogImportClient implements CatalogImportApi {
         );
       });
 
+    const appTitle =
+      this.configApi.getOptionalString('app.title') ?? 'Backstage';
+    const appBaseUrl = this.configApi.getString('app.baseUrl');
+
+    const prBody = `This pull request adds a **Backstage entity metadata file** \
+to this repository so that the component can be added to the \
+[${appTitle} software catalog](${appBaseUrl}).\n\nAfter this pull request is merged, \
+the component will become available.\n\nFor more information, read an \
+[overview of the Backstage software catalog](https://backstage.io/docs/features/software-catalog/software-catalog-overview).`;
+
     const pullRequestResponse = await octo.pulls
       .create({
         owner,
         repo,
         title: `Add ${fileName} config file`,
         head: branchName,
+        body: prBody,
         base: repoData.data.default_branch,
       })
       .catch(e => {

plugins/catalog-import/src/plugin.ts

@@ -20,6 +20,7 @@ import {
   createRouteRef,
   discoveryApiRef,
   githubAuthApiRef,
+  configApiRef,
 } from '@backstage/core';
 import { catalogImportApiRef } from './api/CatalogImportApi';
 import { CatalogImportClient } from './api/CatalogImportClient';
@@ -34,9 +35,13 @@ export const plugin = createPlugin({
   apis: [
     createApiFactory({
       api: catalogImportApiRef,
-      deps: { discoveryApi: discoveryApiRef, githubAuthApi: githubAuthApiRef },
-      factory: ({ discoveryApi, githubAuthApi }) =>
-        new CatalogImportClient({ discoveryApi, githubAuthApi }),
+      deps: {
+        discoveryApi: discoveryApiRef,
+        githubAuthApi: githubAuthApiRef,
+        configApi: configApiRef,
+      },
+      factory: ({ discoveryApi, githubAuthApi, configApi }) =>
+        new CatalogImportClient({ discoveryApi, githubAuthApi, configApi }),
     }),
   ],
 });