You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/customizing-templates/proc-versioning-software-templates.adoc
+11-7Lines changed: 11 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,10 +14,11 @@ As a platform administrator, you can version Software Templates by using the exi
14
14
15
15
.Procedure
16
16
17
-
To add versioning to a Software Template yaml file, modify the Software Template that you want to update and do either of the following steps:
18
-
19
-
* Include the `backstage.io/template-version` annotation in your template. When this annotation is present in your template, it will be automatically used to annotate your catalog entity.
17
+
To add versioning to a Software Template yaml file, complete the following steps:
20
18
19
+
. Modify the Software Template that you want to update.
20
+
. Complete one or both of the following tasks:
21
+
* 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.
21
22
* 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.
22
23
23
24
+
@@ -34,7 +35,10 @@ To add versioning to a Software Template yaml file, modify the Software Template
34
35
----
35
36
36
37
.Verification
37
-
38
-
. link:{configuring-book-url}#ref-creating-templates_configuring-templates[Create a component using the Software Template] that is updated for versioning.
39
-
. In the *Catalog* page, select the newly created Software Template and click *VIEW SOURCE*.
40
-
. In your GitHub page, go to your `catalog-info.yaml` file and you are able to see `backstage.io/template-version`.
38
+
. link:{configuring-book-url}#ref-creating-templates_configuring-templates[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).
39
+
. Check the component in the Catalog UI.
40
+
.. On the *Catalog* page, locate the newly created catalog component.
41
+
.. 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.
42
+
. Only if you have published the catalog component: Check the component file in the repository.
43
+
.. If *VIEW SOURCE* is present in your UI: Click *VIEW SOURCE* to open the stored component file in the repository.
44
+
.. Locate the file manually and verify that the `backstage.io/template-version` annotation is present.
0 commit comments