[GSoC' 24]: M1 Readmes (oppia#20839)

* Updates * Updates * Updates * Updates * Updates
AFZL210 · Aug 26, 2024 · 4097318 · 4097318
1 parent a0d05d2
commit 4097318
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 0 deletions.
diff --git a/core/tests/README.md b/core/tests/README.md
@@ -0,0 +1 @@
+To decide which CI tests need to be run on a PR, we need to know how files depend on each other. These dependencies can be described as a set of dependency trees where the files depend on their parents and are dependencies of their children. The root of each tree is therefore a file that no other file depend upon. These root files are stored in root-files-config.json under one of two keys: RUN_NO_TESTS_ROOT_FILES for files that don't affect any functionality and RUN_ALL_TESTS_ROOT_FILES for files that could change Oppia's behavior. If the CI gives you an error regarding this config file, please add the root file to one of these lists, depending on if it needs to run tests or not. For more information, refer to the wiki here: https://github.com/oppia/oppia/wiki/Partial-CI-Tests-Structure#root-files-config.
diff --git a/core/tests/root-files-config.json b/core/tests/root-files-config.json
@@ -10,6 +10,8 @@
     ".github/SECURITY.md",
     ".github/ISSUE_TEMPLATE/4_server_error_template.md",
     ".github/workflows/README.md",
+    "core/tests/test-modules-mappings/README.md",
+    "core/tests/README.md",
     "assets/README.md",
     "core/templates/domain/exploration/ExplorationMetadataObjectFactorySpec.ts",
     "core/templates/domain/exploration/ExplorationObjectFactorySpec.ts",

diff --git a/core/tests/test-dependencies/README.md b/core/tests/test-dependencies/README.md
@@ -0,0 +1 @@
+This folder holds the files that are needed mainly when running the scripts.check_ci_test_suites_to_run. The files root-files-mapping-generator.ts and typescript-ast-utilities.ts are used to find which root modules and files are linked together. The test-to-modules-matcher.ts and route-to-module-mapping-generator.ts are used by acceptance tests to find out which modules are affected by a certain test. For more information refer to the wiki page here: https://github.com/oppia/oppia/wiki/Partial-CI-Tests-Structure.
diff --git a/core/tests/test-modules-mappings/README.md b/core/tests/test-modules-mappings/README.md
@@ -0,0 +1 @@
+This folder holds the test-modules-mappings of each test type; right now it only contains the mappings for acceptance tests. These mappings are used to determine which tests to run in the Github CI. These files should not be manually altered with your own Angular modules; instead if the CI asks you to update these files, either run the test locally and they will automatically generate, or copy and paste the modules that the CI gives into the needed destination. For more information refer to the wiki page here: https://github.com/oppia/oppia/wiki/Partial-CI-Tests-Structure.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		To decide which CI tests need to be run on a PR, we need to know how files depend on each other. These dependencies can be described as a set of dependency trees where the files depend on their parents and are dependencies of their children. The root of each tree is therefore a file that no other file depend upon. These root files are stored in root-files-config.json under one of two keys: RUN_NO_TESTS_ROOT_FILES for files that don't affect any functionality and RUN_ALL_TESTS_ROOT_FILES for files that could change Oppia's behavior. If the CI gives you an error regarding this config file, please add the root file to one of these lists, depending on if it needs to run tests or not. For more information, refer to the wiki here: https://github.com/oppia/oppia/wiki/Partial-CI-Tests-Structure#root-files-config.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		This folder holds the files that are needed mainly when running the scripts.check_ci_test_suites_to_run. The files root-files-mapping-generator.ts and typescript-ast-utilities.ts are used to find which root modules and files are linked together. The test-to-modules-matcher.ts and route-to-module-mapping-generator.ts are used by acceptance tests to find out which modules are affected by a certain test. For more information refer to the wiki page here: https://github.com/oppia/oppia/wiki/Partial-CI-Tests-Structure.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		This folder holds the test-modules-mappings of each test type; right now it only contains the mappings for acceptance tests. These mappings are used to determine which tests to run in the Github CI. These files should not be manually altered with your own Angular modules; instead if the CI asks you to update these files, either run the test locally and they will automatically generate, or copy and paste the modules that the CI gives into the needed destination. For more information refer to the wiki page here: https://github.com/oppia/oppia/wiki/Partial-CI-Tests-Structure.