From 8d0ac2cc17ad510f815a203ca5407994a560110b Mon Sep 17 00:00:00 2001 From: Geoffrey Huck Date: Sat, 15 Jun 2024 13:58:20 +0200 Subject: [PATCH 1/3] Rename the file so we can include architecture decisions about environment, configuration... --- .../{decisions-services-code-style.md => decisions-app-code.md} | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename backend/{decisions-services-code-style.md => decisions-app-code.md} (97%) diff --git a/backend/decisions-services-code-style.md b/backend/decisions-app-code.md similarity index 97% rename from backend/decisions-services-code-style.md rename to backend/decisions-app-code.md index 4d89c1b..b180d96 100644 --- a/backend/decisions-services-code-style.md +++ b/backend/decisions-app-code.md @@ -5,7 +5,7 @@ nav_order: 1000 parent: Backend --- -# Architecture Decisions: Services & Code Style +# Architecture Decisions: App & Code ## Fields that are not visible to the user due to access rights must not appear in the response at all From 22e18ad383afd7337c72418dddad1cc20405a0cd Mon Sep 17 00:00:00 2001 From: Geoffrey Huck Date: Sat, 15 Jun 2024 14:08:10 +0200 Subject: [PATCH 2/3] Add architecture decision about the env and config. --- backend/decisions-app-code.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/backend/decisions-app-code.md b/backend/decisions-app-code.md index b180d96..55ce451 100644 --- a/backend/decisions-app-code.md +++ b/backend/decisions-app-code.md @@ -7,6 +7,17 @@ parent: Backend # Architecture Decisions: App & Code + +## The environment is forced to `test` in the tests, can never be `test` when running the application, and the `test` environment only read its configuration from `config.yaml.test`, and never from `config.yaml` + +Date: 05/06/2024 + +Why? +- We want to make sure tests are never run on a live database because they erase all the data. + +More info and discussion: https://github.com/France-ioi/AlgoreaBackend/pull/1085 + + ## Fields that are not visible to the user due to access rights must not appear in the response at all Date: 12/09/2023 From f35deb2ec09531e7f1de30c842618d3b5ca27f58 Mon Sep 17 00:00:00 2001 From: Geoffrey Huck Date: Tue, 18 Jun 2024 15:44:57 +0200 Subject: [PATCH 3/3] Update title and link since the page was renamed. --- backend/decisions-app-code.md | 2 +- backend/dev-process.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/backend/decisions-app-code.md b/backend/decisions-app-code.md index 55ce451..3d8b9c3 100644 --- a/backend/decisions-app-code.md +++ b/backend/decisions-app-code.md @@ -1,6 +1,6 @@ --- layout: page -title: "Architecture Decisions: Services & Code Style" +title: "Architecture Decisions: App & Code" nav_order: 1000 parent: Backend --- diff --git a/backend/dev-process.md b/backend/dev-process.md index e0ee7a2..848c590 100644 --- a/backend/dev-process.md +++ b/backend/dev-process.md @@ -54,7 +54,7 @@ parent: Backend - [ ] it renders correctly. Verify locally with the command: "**make serve-swagger**". - [ ] the fields of the request and response have the correct annotations (required, Nullable, ...). -See [Architecture Decisions: Services & Code Style]({{ site.baseurl }}/backend/decisions-services-code-style/). +See [Architecture Decisions: App & Code]({{ site.baseurl }}/backend/decisions-app-code/). **Swagger tip:** You need to have 2 empty lines between paragraphs, otherwise the generated documentation will have everything on the same line.