docs: harmonize examples 'use: ./' syntax explanation (#1534)

* docs: harmonize examples 'use: ./' syntax explanation

* add name to cypress test in node workflow

* change 'above line' to 'line'

Author: MikeMcC399

.github/workflows/example-basic-pnpm.yml

@@ -32,10 +32,7 @@ jobs:
           cache-dependency-path: examples/basic-pnpm/pnpm-lock.yaml
 
       - name: Cypress tests
-        # if you copy this workflow to another repository
-        # take the next line as replacement for ./
-        # uses: cypress-io/github-action@v6
-        uses: ./
+        uses: ./ # if copying, replace with cypress-io/github-action@v6
         with:
           working-directory: examples/basic-pnpm
           # print information about detected browsers, etc

.github/workflows/example-basic.yml

@@ -19,9 +19,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Cypress tests
-        # normally you would write
-        # uses: cypress-io/github-action@v6
-        uses: ./
+        uses: ./ # if copying, replace with cypress-io/github-action@v6
         # the parameters below are only necessary
         # because we are running these examples in a monorepo
         with:

.github/workflows/example-build-artifacts.yml

@@ -6,6 +6,12 @@ name: example-build-artifacts
 # The test jobs use the results from the build job:
 # - dependencies and the Cypress binary are installed using dependency caching
 # - build results are restored using actions/download-artifact
+#
+# In the example jobs, the action is called with
+# uses: ./
+# which runs the action code from the current branch.
+# If you copy this workflow to another repo, replace the line with
+# uses: cypress-io/github-action@v6
 on:
   push:
     branches:
@@ -21,7 +27,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Build app
-        uses: ./ # refers to local instance of cypress-io/github-action@v6
+        uses: ./
         with:
           runTests: false # only build app, don't test yet
           build: npm run build

.github/workflows/example-chrome-for-testing.yml

@@ -18,7 +18,7 @@ jobs:
         with:
           chrome-version: 137
       - name: Cypress info
-        uses: ./
+        uses: ./ # if copying, replace with cypress-io/github-action@v6
         with:
           # just for full picture after installing Cypress
           # print information about detected browsers, etc

.github/workflows/example-chrome.yml

@@ -1,4 +1,9 @@
 name: example-chrome
+# In the example jobs, the action is called with
+# uses: ./
+# which runs the action code from the current branch.
+# If you copy this workflow to another repo, replace the line with
+# uses: cypress-io/github-action@v6
 on:
   push:
     branches:

.github/workflows/example-component-test.yml

@@ -13,9 +13,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
       - name: Cypress run
-        # normally you would write
-        # uses: cypress-io/github-action@v6
-        uses: ./
+        uses: ./ # if copying, replace with cypress-io/github-action@v6
         with:
           working-directory: examples/component-tests
           component: true

.github/workflows/example-config.yml

@@ -1,4 +1,9 @@
 name: example-config
+# In the example jobs, the action is called with
+# uses: ./
+# which runs the action code from the current branch.
+# If you copy this workflow to another repo, replace the line with
+# uses: cypress-io/github-action@v6
 on:
   push:
     branches:

.github/workflows/example-cron.yml

@@ -13,6 +13,6 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Cypress nightly tests 🌃
-        uses: ./
+        uses: ./ # if copying, replace with cypress-io/github-action@v6
         with:
           working-directory: examples/basic

.github/workflows/example-custom-ci-build-id.yml

@@ -14,7 +14,12 @@ name: example-custom-ci-build-id
 # is generated _again_ on workflow re-run. This example
 # shows how to create a unique ID then pass it to
 # multiple testing jobs running in parallel.
-
+#
+# In the example jobs, the action is called with
+# uses: ./
+# which runs the action code from the current branch.
+# If you copy this workflow to another repo, replace the line with
+# uses: cypress-io/github-action@v6
 on:
   push:
     branches:

.github/workflows/example-custom-command.yml

@@ -19,7 +19,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Custom tests
-        uses: ./
+        uses: ./ # if copying, replace with cypress-io/github-action@v6
         with:
           command: npm run custom-test
           working-directory: examples/custom-command