Situation

The workflow .github/workflows/example-custom-ci-build-id.yml contains hybrid use of the action, with both Module API and CLI commands beings used.

The job smoke-tests uses regular action parameters

          record: true
          parallel: true
          group: '1 - smoke tests'
          ci-build-id: ${{ needs.prepare.outputs.uuid }}
          spec: 'cypress/e2e/spec-a.cy.js'
          working-directory: examples/recording

The follow-on job all-tests uses the action with a CLI command

          command: |
            npx cypress run --record --parallel \
              --ci-build-id ${{ needs.prepare.outputs.uuid }} \
              --group "2 - all tests"
          working-directory: examples/recording

Assessment

The command parameter uses a CLI command to run the action, which by-passes the Module API.

Best practice is however to use non-command parameters.

Each of the CLI options can be used with action parameters, so there is no necessity to use the command parameter.

Change

• Convert the all-tests job to use action parameters other than command. Suppress the job summary with publish-summary: false because there are 4 tests load-balanced over 3 containers and the job summary does not consolidate parallel results. Instead, consolidated results can be viewed in Cypress Cloud https://cloud.cypress.io/projects/3tb7jn/runs

          record: true
          parallel: true
          group: '2 - all tests'
          ci-build-id: ${{ needs.prepare.outputs.uuid }}
          publish-summary: false
          working-directory: examples/recording

• Remove the reference to the outdated blog article from the year 2019.

• Remove the icons for consistency with other workflows.

• Reduce all-tests job to 2 parallel containers, as even with 3 containers, load-balancing sometimes uses only 2 containers. The .github/workflows/example-recording.yml workflow, which uses the same examples/recording project, also uses only 2 containers.