feat(catalog): Link launch template in Entity's AboutCard

Signed-off-by: Carlos Esteban Lopez <lcarlosesteb@vmware.com>
This commit is contained in:
Carlos Esteban Lopez
2023-05-19 12:58:25 -05:00
parent c4a77ac680
commit 08f177b910
7 changed files with 43 additions and 3 deletions
+6
View File
@@ -0,0 +1,6 @@
---
'@backstage/plugin-catalog': patch
'example-app': patch
---
Add link from Template entity to the scaffolder launch page for the template in the AboutCard.
+1
View File
@@ -142,6 +142,7 @@ const app = createApp({
bind(catalogPlugin.externalRoutes, {
createComponent: scaffolderPlugin.routes.root,
viewTechDoc: techdocsPlugin.routes.docRoot,
selectedTemplateRoute: scaffolderPlugin.routes.selectedTemplate,
});
bind(apiDocsPlugin.externalRoutes, {
registerApi: catalogImportPlugin.routes.importPage,
+1
View File
@@ -40,6 +40,7 @@
"@backstage/integration-react": "workspace:^",
"@backstage/plugin-catalog-common": "workspace:^",
"@backstage/plugin-catalog-react": "workspace:^",
"@backstage/plugin-scaffolder-common": "workspace:^",
"@backstage/plugin-search-common": "workspace:^",
"@backstage/plugin-search-react": "workspace:^",
"@backstage/theme": "workspace:^",
@@ -49,12 +49,14 @@ import {
IconButton,
makeStyles,
} from '@material-ui/core';
import AddIcon from '@material-ui/icons/Add';
import CachedIcon from '@material-ui/icons/Cached';
import DocsIcon from '@material-ui/icons/Description';
import EditIcon from '@material-ui/icons/Edit';
import React, { useCallback } from 'react';
import { viewTechDocRouteRef } from '../../routes';
import { selectedTemplateRouteRef, viewTechDocRouteRef } from '../../routes';
import { AboutContent } from './AboutContent';
import { isTemplateEntityV1beta3 } from '@backstage/plugin-scaffolder-common';
const useStyles = makeStyles({
gridItemCard: {
@@ -97,6 +99,7 @@ export function AboutCard(props: AboutCardProps) {
const alertApi = useApi(alertApiRef);
const errorApi = useApi(errorApiRef);
const viewTechdocLink = useRouteRef(viewTechDocRouteRef);
const templateRoute = useRouteRef(selectedTemplateRouteRef);
const entitySourceLocation = getEntitySourceLocation(
entity,
@@ -126,6 +129,23 @@ export function AboutCard(props: AboutCardProps) {
}),
};
const subHeaderLinks = [viewInSource, viewInTechDocs];
if (isTemplateEntityV1beta3(entity)) {
const launchTemplate: IconLinkVerticalProps = {
label: 'Launch Template',
icon: <AddIcon />,
href:
templateRoute &&
templateRoute({
templateName: entity.metadata.name,
namespace: entity.metadata.namespace || DEFAULT_NAMESPACE,
}),
};
subHeaderLinks.push(launchTemplate);
}
let cardClass = '';
if (variant === 'gridItem') {
cardClass = classes.gridItemCard;
@@ -179,7 +199,7 @@ export function AboutCard(props: AboutCardProps) {
</IconButton>
</>
}
subheader={<HeaderIconLinkRow links={[viewInSource, viewInTechDocs]} />}
subheader={<HeaderIconLinkRow links={subHeaderLinks} />}
/>
<Divider />
<CardContent className={cardContentClass}>
+6 -1
View File
@@ -21,7 +21,11 @@ import {
entityRouteRef,
starredEntitiesApiRef,
} from '@backstage/plugin-catalog-react';
import { createComponentRouteRef, viewTechDocRouteRef } from './routes';
import {
createComponentRouteRef,
selectedTemplateRouteRef,
viewTechDocRouteRef,
} from './routes';
import {
createApiFactory,
createComponentExtension,
@@ -77,6 +81,7 @@ export const catalogPlugin = createPlugin({
externalRoutes: {
createComponent: createComponentRouteRef,
viewTechDoc: viewTechDocRouteRef,
selectedTemplateRoute: selectedTemplateRouteRef,
},
__experimentalConfigure(
options?: CatalogInputPluginOptions,
+6
View File
@@ -30,6 +30,12 @@ export const viewTechDocRouteRef = createExternalRouteRef({
params: ['namespace', 'kind', 'name'],
});
export const selectedTemplateRouteRef = createExternalRouteRef({
id: 'selected-template',
optional: true,
params: ['namespace', 'templateName'],
});
export const rootRouteRef = createRouteRef({
id: 'catalog',
});
+1
View File
@@ -5739,6 +5739,7 @@ __metadata:
"@backstage/plugin-catalog-common": "workspace:^"
"@backstage/plugin-catalog-react": "workspace:^"
"@backstage/plugin-permission-react": "workspace:^"
"@backstage/plugin-scaffolder-common": "workspace:^"
"@backstage/plugin-search-common": "workspace:^"
"@backstage/plugin-search-react": "workspace:^"
"@backstage/test-utils": "workspace:^"