Merge pull request #5153 from MikeMcC399/gha/version-selection

Recommend use of github-action v5 branch instead of v5.x.x tag

Author: jaffrepaul

docs/guides/continuous-integration/github-actions.mdx

@@ -49,19 +49,14 @@ running Cypress tests. This action provides npm, pnpm or yarn installation,
 custom caching, additional configuration options and simplifies setup of
 advanced workflows with Cypress in the GitHub Actions platform.
 
-### Explicit Version Number
+### Version Number Selection
 
 :::info
 
 <strong>GitHub Action Version Number</strong>
 
-We recommend using the explicit version number of the Cypress GitHub Action to
-prevent accidentally running tests with a new version of the action that may
-have breaking changes.
-
-Read the
-[GitHub Action documentation](https://github.com/cypress-io/github-action#explicit-version)
-for more information
+We recommend binding to the action's latest major version by specifying `v5`
+when using the action.
 
 :::
 
@@ -71,22 +66,29 @@ For Example:
 jobs:
   cypress-run:
     steps:
-      uses: cypress-io/github-action@v5.1.0
+      uses: cypress-io/github-action@v5
 ```
 
+Alternatively, as a mitigation strategy for unforeseen breaks, bind to a
+specific
+[release version tag](https://github.com/cypress-io/github-action/releases), for
+example `cypress-io/[email protected]`. Read the
+[Cypress GitHub Action documentation](https://github.com/cypress-io/github-action#action-version)
+for more information.
+
 ## Basic Setup
 
 <DocsVideo src="https://youtube.com/embed/vVr7DXDdUks" />
 
-The example below is basic CI setup and job using the
+The example below is a basic CI setup and job using the
 [Cypress GitHub Action](https://github.com/marketplace/actions/cypress-io) to
 run Cypress tests within the Electron browser. This GitHub Action configuration
 is placed within `.github/workflows/main.yml`.
 
 ```yaml
 name: Cypress Tests
 
-on: [push]
+on: push
 
 jobs:
   cypress-run:
@@ -97,7 +99,7 @@ jobs:
       # Install NPM dependencies, cache them correctly
       # and run all Cypress tests
       - name: Cypress run
-        uses: cypress-io/github-action@v5.x.x # use the explicit version number
+        uses: cypress-io/github-action@v5
         with:
           build: npm run build
           start: npm start
@@ -116,11 +118,11 @@ example project and place the above GitHub Action configuration in
 
 **How this action works:**
 
-- On _push_ to this repository, this job will provision and start GitHub-hosted
-  Ubuntu Linux instance for running the outlined `steps` for the declared
-  `cypress-run` job within the `jobs` section of the configuration.
+- On _push_ to this repository, this job will provision and start a
+  GitHub-hosted Ubuntu Linux instance to run the outlined `steps` for the
+  declared `cypress-run` job within the `jobs` section of the configuration.
 - The [GitHub checkout Action](https://github.com/marketplace/actions/checkout)
-  is used to checkout our code from our GitHub repository.
+  is used to check out our code from our GitHub repository.
 - Finally, our Cypress GitHub Action will:
   - Install npm dependencies
   - Build the project (`npm run build`)
@@ -143,7 +145,7 @@ tests in Firefox by passing the `browser: firefox` attribute to the
 ```yaml
 name: Cypress Tests using Cypress Docker Image
 
-on: [push]
+on: push
 
 jobs:
   cypress-run:
@@ -156,9 +158,9 @@ jobs:
       # Install NPM dependencies, cache them correctly
       # and run all Cypress tests
       - name: Cypress run
-        uses: cypress-io/github-action@v5.x.x # use the explicit version number
+        uses: cypress-io/github-action@v5
         with:
-          # Specify Browser since container image is compile with Firefox
+          # Specify Browser since container image is compiled with Firefox
           browser: firefox
 ```
 
@@ -185,7 +187,7 @@ action and will save the state of the `build` directory for the worker jobs.
 ```yaml
 name: Cypress Tests with installation job
 
-on: [push]
+on: push
 
 jobs:
   install:
@@ -203,7 +205,7 @@ jobs:
           path: build
 
       - name: Cypress install
-        uses: cypress-io/github-action@v5.x.x # use the explicit version number
+        uses: cypress-io/github-action@v5
         with:
           # Disable running of tests within install job
           runTests: false
@@ -218,7 +220,7 @@ below in a worker job.
 ```yaml
 name: Cypress Tests with Dependency and Artifact Caching
 
-on: [push]
+on: push
 
 jobs:
   # install:
@@ -239,9 +241,9 @@ jobs:
       # Install NPM dependencies, cache them correctly
       # and run all Cypress tests
       - name: Cypress run
-        uses: cypress-io/github-action@v5.x.x # use the explicit version number
+        uses: cypress-io/github-action@v5
         with:
-          # Specify Browser since container image is compile with Firefox
+          # Specify Browser since container image is compiled with Firefox
           browser: firefox
           build: yarn build
 ```
@@ -288,7 +290,7 @@ action will save the state of the `build` directory for the worker jobs.
 ```yaml
 name: Cypress Tests with installation job
 
-on: [push]
+on: push
 
 jobs:
   install:
@@ -299,7 +301,7 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Cypress install
-        uses: cypress-io/github-action@v5.x.x # use the explicit version number
+        uses: cypress-io/github-action@v5
         with:
           # Disable running of tests within install job
           runTests: false
@@ -336,7 +338,7 @@ action will retrieve the `build` directory saved in the install job.
 ```yaml
 name: Cypress Tests with Install Job and UI Chrome Job x 5
 
-on: [push]
+on: push
 
 jobs:
   install:
@@ -362,7 +364,7 @@ jobs:
           path: build
 
       - name: 'UI Tests - Chrome'
-        uses: cypress-io/github-action@v5.x.x # use the explicit version number
+        uses: cypress-io/github-action@v5
         with:
           # we have already installed all dependencies above
           install: false
@@ -486,7 +488,7 @@ identification of each build to avoid confusion when re-running a build.
 
 ```
 name: Cypress tests
-on: [push]
+on: push
 jobs:
   cypress-run:
     name: Cypress run
@@ -496,7 +498,7 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Cypress run
-        uses: cypress-io/github-action@v5.x.x # use the explicit version number
+        uses: cypress-io/github-action@v5
         with:
           record: true
         env:
@@ -513,7 +515,7 @@ details.
 
 ```
 name: Cypress tests
-on: [push]
+on: push
 jobs:
   cypress-run:
     name: Cypress run
@@ -523,7 +525,7 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Cypress run
-        uses: cypress-io/github-action@v5.x.x # use the explicit version number
+        uses: cypress-io/github-action@v5
         with:
           record: true
         env: