💡 Added comments to cypress github action file

facebookresearch · Jul 26, 2022 · 4a11a8a · 4a11a8a
1 parent 23d66d9
commit 4a11a8a
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/.github/workflows/cypress-end-to-end-tests.yml b/.github/workflows/cypress-end-to-end-tests.yml
@@ -5,9 +5,10 @@ on:
     branches: [main]
 
 jobs:
+  # This job is made to setup path filtering, learn more about it here: https://github.com/facebookresearch/Mephisto/pull/857
   changes:
     runs-on: ubuntu-latest
-    # Set job outputs to values from filter step
+    # Set job outputs to values from filters step below
     outputs:
       static_react_task: ${{ steps.filter.outputs.static_react_task }}
       static_react_task_with_tips: ${{ steps.filter.outputs.static_react_task_with_tips }}
@@ -21,7 +22,6 @@ jobs:
       mephisto-task: ${{ steps.filter.outputs.mephisto-task }}
       mephisto-worker-addons: ${{ steps.filter.outputs.mephisto-worker-addons }}
     steps:
-      # For pull requests it's not necessary to checkout the code
       - uses: actions/checkout@v3
         with:
           fetch-depth: 2
@@ -52,6 +52,7 @@ jobs:
             mephisto-worker-addons:
               - 'packages/mephisto-worker-addons/src/**'
 
+  # Learn more about this test here: https://github.com/facebookresearch/Mephisto/pull/795
   static-react-task:
     needs: changes
     if: ${{ (needs.changes.outputs.static_react_task == 'true') || (needs.changes.outputs.mephisto-task == 'true') || (needs.changes.outputs.abstractions == 'true') || (needs.changes.outputs.data_model == 'true') || (needs.changes.outputs.operations == 'true') || (needs.changes.outputs.tools == 'true')}}
@@ -96,6 +97,7 @@ jobs:
           command-prefix: yarn dlx
           headless: true
 
+  # Learn more about the remote_procedure_tests here: https://github.com/facebookresearch/Mephisto/pull/800
   remote_procedure_template:
     needs: changes
     if: ${{ (needs.changes.outputs.template == 'true') || (needs.changes.outputs.mephisto-task == 'true') || (needs.changes.outputs.abstractions == 'true') || (needs.changes.outputs.data_model == 'true') || (needs.changes.outputs.operations == 'true') || (needs.changes.outputs.tools == 'true')}}
@@ -230,6 +232,7 @@ jobs:
           command-prefix: yarn dlx
           headless: true
 
+  # Learn more about this test here: https://github.com/facebookresearch/Mephisto/pull/833
   static_react_task_with_tips:
     needs: changes
     if: ${{ (needs.changes.outputs.static_react_task_with_tips == 'true') || (needs.changes.outputs.mephisto-task == 'true') || (needs.changes.outputs.mephisto-worker-addons == 'true') || (needs.changes.outputs.abstractions == 'true') || (needs.changes.outputs.data_model == 'true') || (needs.changes.outputs.operations == 'true') || (needs.changes.outputs.tools == 'true')}}