Merge pull request #308 from DefangLabs/detail-test-procedure

Add information about test procedure

Author: raphaeltm

README.md

@@ -6,4 +6,8 @@ Browse through the [./samples](./samples) directory, or search and browse in the
 
 ## Adding Samples
 
-To start working on a new sample, run `. ./scripts/new-sample` from the root of the repository. This will create a new sample directory, with some basic scaffolding to get you started. Look for `#REMOVE_ME_AFTER_EDITING` in your new project to look for things that you should probably be changing/checking per sample. Feel free to remove files, like `compose.dev.yaml` if they aren't necessary for your sample.
+To start working on a new sample, run `. ./scripts/new-sample` from the root of the repository. This will create a new sample directory, with some basic scaffolding to get you started. Look for `#REMOVE_ME_AFTER_EDITING` in your new project to look for things that you should probably be changing/checking per sample. Feel free to remove files, like `compose.dev.yaml` if they aren't necessary for your sample.
+
+### 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.

starter-sample/compose.yaml

@@ -13,6 +13,7 @@ services:
         mode: ingress
     environment: # Secrets and env vars #REMOVE_ME_AFTER_EDITING
       MONGODB_URI:
+      #REMOVE_ME_AFTER_EDITING NOTE: If you add any secrets in here, make sure to add them to the `deploy-changed-samples.yml` workflow file as well. See the README for more information.
     healthcheck:
       # wget or curl required for healthchecks on services with a published port
       # this gets parsed by Defang and provided to the load balancers as well