Uploaded image for project: 'Red Hat Internal Developer Platform'
  1. Red Hat Internal Developer Platform
  2. RHIDP-7306

Scaffolder action to annotate the template version

XMLWordPrintable

    • Scaffolder action to annotate the template version
    • XS
    • False
    • Hide

      None

      Show
      None
    • False
    • To Do
    • RHIDP-6905 - Be able to version the software templates
    • QE Needed, Docs Needed, TE Needed, Customer Facing, PX Needed
    • 0% To Do, 0% In Progress, 100% Done
    • Hide
      = Versioning for software templates

      {product-very-short} has been enhanced to provide crucial traceability, allowing users to easily identify the template version used to create a specific component. This enhancement helps determine if an older entity needs updating or if a bug is linked to a particular template version.

      Scaffolder templates can now be versioned using the backstage.io/template-version annotation and the `catalog:template:version` action. When used with the `catalog:template:version` action, the annotation of the template is applied to the generated catalog entity.
      Show
      = Versioning for software templates {product-very-short} has been enhanced to provide crucial traceability, allowing users to easily identify the template version used to create a specific component. This enhancement helps determine if an older entity needs updating or if a bug is linked to a particular template version. Scaffolder templates can now be versioned using the backstage.io/template-version annotation and the `catalog:template:version` action. When used with the `catalog:template:version` action, the annotation of the template is applied to the generated catalog entity.
    • Feature
    • Done

      EPIC Goal

      Create a new scaffolder action that will annotate catalog entities with the version of the software template that created them.

      Background/Feature Origin

      Today, we have the ability to set the relations between an entity that was created by a particular software template using `scaffoldedFrom` from the `@backstage-community/plugin-scaffolder-backend-module-annotator` plugin. We would like to take this a step forward and now include versioning information to the entity based on the version of the template that created it.

      Why is this important?

      This will allow users to be able to reference what version of a particular template they used to create their entity. This can help in identify problems and give more information about where the source of the issue might be. This also can be used as another mechanism for tracking the lifecycle of a particular template

      User Scenarios

      As a platform engineer, I want to be able to version software templates

      As a platform engineer, I want to be able to version the catalog entities that are created using my software templates

      Dependencies (internal and external)

      Acceptance Criteria

      Release Enablement/Demo - Provide necessary release enablement details
      and documents

      DEV - Upstream code and tests merged: <link to meaningful PR or GitHub
      Issue>

      DEV - Upstream documentation merged: <link to meaningful PR or GitHub
      Issue>

      DEV - Downstream build attached to advisory: <link to errata>

      QE - Test plans in Playwright: <link or reference to playwright>

      QE - Automated tests merged: <link or reference to automated tests>

      DOC - Downstream documentation merged: <link to meaningful PR>

              rh-ee-pknight Patrick Knight
              rh-ee-pknight Patrick Knight
              RHIDP - Plugins
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Created:
                Updated:
                Resolved: