Skip to content

Commit 19a45ae

Browse files
authored
Patch fixes (#120)
2 parents 447252d + c515a84 commit 19a45ae

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

.github/CONTRIBUTING.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,13 @@ This template is a place to pull together agreed best practices from various sou
1111

1212
## Checking your changes before making a PR
1313

14-
The template has some tests that generating from scratch and updating the [example](https://github.com/DiamondLightSource/python-copier-template-example) produce the same result, but it is difficult to that things like CI and docs are still generated correctly. You can ease this process by:
14+
The template has tests for:
15+
16+
- Generating a new project from scratch
17+
- Updating the [example project](https://github.com/DiamondLightSource/python-copier-template-example)
18+
- Checking that both of the above produce the same results
19+
20+
However, this does not test whether processes like CI and docs work correctly. You can ensure that these are checked by:
1521

1622
- Making your changes on a branch of <https://github.com/DiamondLightSource/python-copier-template>
1723
- Running `copier update --vcs-ref=<branch_name>` in the repo where you would like to demonstrate the behaviour
@@ -22,3 +28,7 @@ The template has some tests that generating from scratch and updating the [examp
2228
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.
2329

2430
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)
31+
32+
## Making a Tagged GitHub Release
33+
34+
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 release should be made as soon as possible.

catalog-info.yaml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,3 @@ spec:
126126
links:
127127
- title: Repository
128128
url: ${{ steps.publish.output.remoteUrl }}
129-
- title: Open in catalog
130-
icon: catalog
131-
entityRef: ${{ steps.register.output.entityRef }}

0 commit comments

Comments
 (0)