Chapter 4. About Software Templates

1. Modify the Software Template that you want to update.

2. Complete one or both of the following tasks:

   • Include the backstage.io/template-version annotation in your template. When this annotation is present in your template, it is automatically used to annotate your catalog entity and a default version value is displayed.
   • Pass the backstage.io/template-version annotation as input to the action. This method takes precedence over the annotation in the template itself. It allows the user running the template to specify the version they wish to generate.

   # ...
   - id: version-templateRef
     name: Append the version of this template to the entityRef
     action: catalog:template:version
     input:
       annotations:
         backstage.io/template-version: ${{ parameters.version }}
   # ...

   Copy to Clipboard Toggle word wrap

Verification

1. Create a catalog component using the updated Software Template. This step creates a new component in Backstage and optionally, pushes files to an external repository (For example, GitHub, GitLab).

2. Check the component in the Catalog UI.

   1. On the Catalog page, locate the newly created catalog component.
   2. Verify that the backstage.io/template-version annotation is present in the entity. You can use INSPECT ENTITY and select YAML Raw or JSON Raw view to find the annotation in the component definition.

3. Only if you have published the catalog component: Check the component file in the repository.

   1. If VIEW SOURCE is present in your UI: Click VIEW SOURCE to open the stored component file in the repository.
   2. Locate the file manually and verify that the backstage.io/template-version annotation is present.

Procedure

1. To enable the notifications, in your Red Hat Developer Hub app-config.yaml file, add the following codes:

   1. In the dynamicPlugins:frontend section:

      frontend:
        backstage.plugin-notifications:
          dynamicRoutes:
            - importName: NotificationPage
      	      menuItem:
      	        config:
      	          props:
                    titleCounterEnabled: true
      		          webNotificationsEnabled: false
      	        importName: NotificationsSidebarItem
      	        path: /notifications

      Copy to Clipboard Toggle word wrap

   2. In a new section:

      scaffolder:
        notifications:
          templateUpdate:
            enabled: true # Set to false to disable notifications

      Copy to Clipboard Toggle word wrap

      You can also customize the notification title and description as shown in the following code:

      scaffolder:
        notifications:
          templateUpdate:
            enabled: true
            message:
              title: 'Custom title for $ENTITY_DISPLAY_NAME'
              description: 'Custom description'

      Copy to Clipboard Toggle word wrap

      where:

      enabled

      Set to true to enable the notification. Default value is false.

      message:title

      Enter the notification title.

      message:description

      Enter the notification description.