updated comments in CI files

.github/workflows/check-migrations.yml

@@ -16,6 +16,7 @@ concurrency:
 permissions: {}
 
 jobs:
+  # This generates a matrix with all the required jobs which will be run in the next step
   runtime-matrix:
     runs-on: ubuntu-latest
     outputs:
@@ -36,6 +37,8 @@ jobs:
           TASKS=$(echo $TASKS | jq -c .)
           echo "runtime=$TASKS" >> $GITHUB_OUTPUT
 
+  # This runs all the jobs in the matrix. It is required by the "confirmMigrationsPassed" job, so
+  # if they all pass, that job will pass too.
   check-migrations:
     needs: [runtime-matrix]
     continue-on-error: true
@@ -78,10 +81,14 @@ jobs:
           checks: "pre-and-post"
           extra-args: ${{ env.EXTRA_ARGS }}
 
+  # This will only run if all the tests in its "needs" array passed.
+  # Add this as your required job, becuase if the matrix changes size (new things get added)
+  # it will still require all the steps to succeed.
+  # If you add more jobs, remember to add them to the "needs" array.
   confirmMigrationsPassed:
     runs-on: ubuntu-latest
     name: All migrations passed
-    # If any new job gets added, be sure to add it to this list
+    # If any new job gets added, be sure to add it to this array
     needs: [check-migrations]
     steps:
       - run: echo '### Good job! All the migrations passed 🚀' >> $GITHUB_STEP_SUMMARY

.github/workflows/test.yml

@@ -12,6 +12,7 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+  # This generates a matrix with all the required jobs which will be run in the next step
   runtime-matrix:
     runs-on: ubuntu-latest
     outputs:
@@ -38,6 +39,7 @@ jobs:
           echo $TASKS
           echo "itest=$TASKS" >> $GITHUB_OUTPUT
 
+  # Job required by "confirmTestPassed"
   runtime-test:
     needs: [runtime-matrix]
     continue-on-error: true
@@ -94,6 +96,7 @@ jobs:
           RUSTFLAGS: "-C debug-assertions -D warnings"
           SKIP_WASM_BUILD: 1
 
+  # Job required by "confirmTestPassed"
   integration-test:
     needs: [integration-test-matrix]
     continue-on-error: true
@@ -144,6 +147,7 @@ jobs:
         env:
           RUSTFLAGS: "-C debug-assertions -D warnings"
 
+  # Job required by "confirmTestPassed"
   build-chain-spec-generator:
     runs-on: ubuntu-latest
     steps:
@@ -241,6 +245,10 @@ jobs:
           export PATH=$(pwd)/target/release:$PATH
           cargo test --manifest-path integration-tests/zombienet/Cargo.toml
 
+  # This will only run if all the tests in its "needs" array passed.
+  # Add this as your required job, becuase if the matrix changes size (new things get added)
+  # it will still require all the steps to succeed.
+  # If you add more tests, remember to add them to the "needs" array.
   confirmTestPassed:
     runs-on: ubuntu-latest
     name: All tests passed