Clarify config value handling in testing samples

raphaeltm · web-flow · commit c9760693a506 · 2025-09-30T18:04:10.000+02:00
Added a note about handling config values in tests.
diff --git a/README.md b/README.md
@@ -10,4 +10,4 @@ To start working on a new sample, run `. ./scripts/new-sample` from the root of
 
 ### Testing Samples
 
-When you add a new sample, make sure to add any config vals to the `deploy-changed-samples.yml` workflow. They need to be prefixed with `TEST_` and those values need to be set in the repo secrets.
+When you add a new sample, make sure to add any config vals to the `deploy-changed-samples.yml` workflow. They need to be prefixed with `TEST_` and those values need to be set in the repo secrets. **NOTE** at the moment test break if we have a config value that only shows up in string interpolation in a longer string, for example in `ENV_NAME: proto://user:${PASSWORD}@host` if `PASSWORD` only ever shows up in that longer string, it will break the test. A workaround is to just add a line with `PASSWORD:` in the environment section, so the test can pick it up. Ugly, but works for now.

Original file line number	Diff line number	Diff line change
@@ -10,4 +10,4 @@ To start working on a new sample, run `. ./scripts/new-sample` from the root of
`10`	`10`
`11`	`11`	`### Testing Samples`
`12`	`12`
`13`		-When you add a new sample, make sure to add any config vals to the `deploy-changed-samples.yml` workflow. They need to be prefixed with `TEST_` and those values need to be set in the repo secrets.
	`13`	+When you add a new sample, make sure to add any config vals to the `deploy-changed-samples.yml` workflow. They need to be prefixed with `TEST_` and those values need to be set in the repo secrets. NOTE at the moment test break if we have a config value that only shows up in string interpolation in a longer string, for example in `ENV_NAME: proto://user:${PASSWORD}@host` if `PASSWORD` only ever shows up in that longer string, it will break the test. A workaround is to just add a line with `PASSWORD:` in the environment section, so the test can pick it up. Ugly, but works for now.