Skip to content

Commit f3d1282

Browse files
committed
added note on making a release when changing the catalog-info.yaml file (ui)
1 parent 5d7f8c0 commit f3d1282

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,7 @@ The template has some tests that generating from scratch and updating the [examp
2222
It is recommended that developers use a [vscode devcontainer](https://code.visualstudio.com/docs/devcontainers/containers). This repository contains configuration to set up a containerized development environment that suits its own needs.
2323

2424
For more information on common tasks like setting up a developer environment, running the tests, and setting a pre-commit hook, see the [How-to guides](https://diamondlightsource.github.io/python-copier-template/main/how-to.html)
25+
26+
## Making a Tagged GitHub Release
27+
28+
When making changes to the `catalog-info.yaml` file, a release **must** be made. The Backstage Developer Portal produces its UI for the template using this file from the `main` branch whereas copier takes the template from the latest tag. Therefore, any differences between the copier variables could cause a breaking change so a major version release should be made.

0 commit comments

Comments
 (0)