milliehartnt123
dd96c3b4cd
New file to describe how to update a component using the Backstage UI. Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>
1.4 KiB
id, title, description
| id | title | description |
|---|---|---|
| update-a-component | Update a Component | Update an existing component. |
Audience: Developers
Overview
Components in the software catalog are created using a software template. The template generates a catalog-info.yaml file in either GitHub or GitLab that defines the entity. To update the component, you must edit its corresponding catalog-info.yaml entity definition file.
Updating the component
To update a component using the Backstage UI:
-
Select the "Edit" icon associated with the component. In this example, the
tutorialentity is selected.
The associated
catalog-info.yamlfile is displayed.
-
Make your changes to the YAML file. In this example, the name of the component is changed to
mytutorial.
-
Select
Commit changesto commit your changes to the appropriate branch and go through your normal PR review procedure. -
Once the updated
catalog-info.yamlfile has been merged into the branch associated with the component, then you will see the updated information in the software catalog.
