From ac4f61b42be3d32d54641f4f2f24010e65781821 Mon Sep 17 00:00:00 2001 From: Owen Harvey Date: Fri, 29 Sep 2023 17:56:51 +1000 Subject: [PATCH 1/3] Hotfix: Adding a test config file to the PR guidelines. --- docs/src/developer/developer/pr-guidelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/developer/developer/pr-guidelines.md b/docs/src/developer/developer/pr-guidelines.md index be0bf1f01b1..02b8dbff0cb 100644 --- a/docs/src/developer/developer/pr-guidelines.md +++ b/docs/src/developer/developer/pr-guidelines.md @@ -81,7 +81,7 @@ Add to `charts/nginz/values.yaml`, under the `galley` section: If a PR adds new configuration options for say brig, the following files need to be edited: * [ ] The parser under `services/brig/src/Brig/Options.hs` -* [ ] The integration test config: `services/brig/brig.integration.yaml` +* [ ] The integration test config: `services/brig/brig.integration.yaml` and `charts/cargohold/templates/tests/configmap.yaml` * [ ] The charts: `charts/brig/templates/configmap.yaml` * [ ] The default values: `charts/brig/values.yaml` * [ ] The values files for CI: `hack/helm_vars/wire-server/values.yaml.gotmpl` From 8f9995ae01280fdc5e82ea1e15c2faa6dee71f4a Mon Sep 17 00:00:00 2001 From: Owen Harvey Date: Fri, 29 Sep 2023 17:58:17 +1000 Subject: [PATCH 2/3] Adding a changelog --- changelog.d/4-docs/hotfix-pr-guidelines | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/4-docs/hotfix-pr-guidelines diff --git a/changelog.d/4-docs/hotfix-pr-guidelines b/changelog.d/4-docs/hotfix-pr-guidelines new file mode 100644 index 00000000000..940c66b8fff --- /dev/null +++ b/changelog.d/4-docs/hotfix-pr-guidelines @@ -0,0 +1 @@ +Adding a testing config entry to the PR guidelines. \ No newline at end of file From 4372079aaf436beceb2429f3ca24d14ca1aa1111 Mon Sep 17 00:00:00 2001 From: Owen Harvey Date: Wed, 11 Oct 2023 16:59:53 +1000 Subject: [PATCH 3/3] Update based on PR feedback --- docs/src/developer/developer/pr-guidelines.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/src/developer/developer/pr-guidelines.md b/docs/src/developer/developer/pr-guidelines.md index 02b8dbff0cb..09b7e37fd22 100644 --- a/docs/src/developer/developer/pr-guidelines.md +++ b/docs/src/developer/developer/pr-guidelines.md @@ -81,12 +81,15 @@ Add to `charts/nginz/values.yaml`, under the `galley` section: If a PR adds new configuration options for say brig, the following files need to be edited: * [ ] The parser under `services/brig/src/Brig/Options.hs` -* [ ] The integration test config: `services/brig/brig.integration.yaml` and `charts/cargohold/templates/tests/configmap.yaml` +* [ ] The integration test config: `services/brig/brig.integration.yaml` * [ ] The charts: `charts/brig/templates/configmap.yaml` * [ ] The default values: `charts/brig/values.yaml` * [ ] The values files for CI: `hack/helm_vars/wire-server/values.yaml.gotmpl` * [ ] The configuration docs: `docs/src/developer/reference/config-options.md` +Additional configuration may also exist for services in the following locations. +* [ ] `charts/$SERVICE/templates/tests/configmap.yaml` + If any new configuration value is required and has no default, then: * [ ] Write a changelog entry in `0-release-notes` advertising the new configuration value