docs(nx-cloud): use correct yaml field for job name github

nrwl · Jan 6, 2025 · aae1cf2 · aae1cf2
1 parent 8f24935
commit aae1cf2
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 6 deletions.
diff --git a/docs/nx-cloud/features/dynamic-agents.md b/docs/nx-cloud/features/dynamic-agents.md
@@ -10,7 +10,7 @@ By default, when you set up [Nx Agents](/ci/features/distribute-task-execution)
 ...
 jobs:
   - job: main
-    displayName: Main Job
+    name: Main Job
     ...
     steps:
       ...
@@ -68,7 +68,7 @@ You can then reference your distribution configuration in your CI pipeline confi
 ...
 jobs:
   - job: main
-    displayName: Main Job
+    name: Main Job
     ...
     steps:
       ...

diff --git a/docs/nx-cloud/reference/assignment-rules.md b/docs/nx-cloud/reference/assignment-rules.md
@@ -103,15 +103,15 @@ The following is an example of what this looks like within a github actions pipe
 ...
 jobs:
   main:
-    displayName: Main Job
+    name: Main Job
     ...
     steps:
       ...
       - run: npx nx-cloud start-ci-run --assignment-rules=.nx/workflows/assignment-rules.yaml --stop-agents-after="e2e-ci"
       - ..
 
   medium-agents:
-    displayName: Agents ${{ matrix.agent }}
+    name: Agents ${{ matrix.agent }}
     runs-on:
       group: medium-agents
     strategy:
@@ -121,6 +121,9 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
+      - name: Install dependencies
+        run: npm ci
+
       ...
 
       - name: Start Agent ${{ matrix.agent }}
@@ -130,7 +133,7 @@ jobs:
           NX_AGENT_LAUNCH_TEMPLATE: "linux-medium" # This value needs to match one of the 'runs-on' values defined in the assignment rules
 
   large-agents:
-    displayName: Agents ${{ matrix.agent }}
+    name: Agents ${{ matrix.agent }}
     runs-on:
       group: large-agents
     strategy:
@@ -141,6 +144,9 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
+      - name: Install dependencies
+        run: npm ci
+
       ... # other setup steps
 
       - name: Start Agent ${{ matrix.agent }}
@@ -183,7 +189,7 @@ You can then reference your distribution configuration in your CI pipeline confi
 ...
 jobs:
   - job: main
-    displayName: Main Job
+    name: Main Job
     ...
     steps:
       ...