feat(scaffolder): create custom action for scaffolder templates

[debsmita1]

Resolves:

https://issues.redhat.com/browse/RHIDP-2192
RHIDP-2221

Test setup:

• Follow the README.md to integrate the custom action plugin in the backend.

• Changes in app-config.yaml

catalog:
  location:
    # Example template
    - type: url
      target: https://github.com/debsmita1/nodejs-ex-1/blob/master/local-template.yaml
      rules:
        - allow: [Template]

• Changes in App.tsx

import {
  CatalogEntityPage,
  CatalogIndexPage,
  CatalogTable,
  CatalogTableRow,
  CatalogTableColumnsFunc,
} from '@backstage/plugin-catalog';


export const AppBase = () => {
  const { AppProvider, AppRouter, dynamicRoutes } =
    useContext(DynamicRootContext);
  const myCustomColumnsFunc: CatalogTableColumnsFunc = entityListContext => {
    if (entityListContext.filters.kind?.value === 'component') {
      return [
        ...CatalogTable.defaultColumnsFunc(entityListContext),
        {
          title: 'Created At',
          ender: (data: CatalogTableRow) =>
            data.entity.metadata.annotations?.['backstage.io/createdAt'],
        },
      ];
    }

    return CatalogTable.defaultColumnsFunc(entityListContext);
  };
  .....
  
  
  <Route
       path="/catalog"
       element={<CatalogIndexPage columns={myCustomColumnsFunc} />}
   />

[rohitkrai03]

Overall looks good to me but I am thinking if we really need a custom action for this. Are there plans to use this custom action for other use cases as well?

[debsmita1]

Overall looks good to me but I am thinking if we really need a custom action for this. Are there plans to use this custom action for other use cases as well?

@rohitkrai03 updated the PR to create a generic action to annotate objects with labels and annotations. PTAL

[Zaperex]

@debsmita1 I noticed you added a generic custom action for annotating the labels and annotations. I have a similar custom action in the works that appends a spec.scaffoldedFrom field to the catalog-info.yaml to enable a custom relation link between software templates and the catalog entities they generated.

I was wondering if it would be a good idea to extend this generic action to allow modification of the spec field (and potentially other fields in the future). Then we can potentially export and publish both of these catalog-info.yaml modification custom actions (timestamping, adding spec.templatedFrom field) alongside this generic custom action as a common package of catalog-info.yaml modification custom actions rather than publishing multiple packages for all the future catalog-info.yaml modification custom actions. This would be similar to how the built-in backstage actions are published and exported.

What are you thoughts?

[debsmita1]

@debsmita1 I noticed you added a generic custom action for annotating the labels and annotations. I have a similar custom action in the works that appends a spec.scaffoldedFrom field to the catalog-info.yaml to enable a custom relation link between software templates and the catalog entities they generated.

I was wondering if it would be a good idea to extend this generic action to allow modification of the spec field (and potentially other fields in the future). Then we can potentially export and publish both of these catalog-info.yaml modification custom actions (timestamping, adding spec.templatedFrom field) alongside this generic custom action as a common package of catalog-info.yaml modification custom actions rather than publishing multiple packages for all the future catalog-info.yaml modification custom actions. This would be similar to how the built-in backstage actions are published and exported.

What are you thoughts?

@Zaperex Absolutely! This totally makes sense. I will update my PR to allow modification in the spec field

[Zaperex]

I made a PR (debsmita1#3) on your branch with some fixes for the package.json exporting to allow it to work in the new backend system. Also fixed up the yarn lint issues and the yarn build issues so it should pass the tests.

[rohitkrai03]

@debsmita1 Overall looks good. I think it would be beneficial if you could also provide an example template, similar to the one shown here - https://github.com/janus-idp/backstage-plugins/tree/main/plugins/kubernetes-actions/examples/templates.

[rohitkrai03]

Maybe add a section on top that explains what this custom action package provides overall? Like all the features and then the specific actions for timestamping and scafolded-from.

[debsmita1]

I have updated the Readme to include usage section