test: harmonize example custom-ci-build-id to use module API only#1454
Merged
jennifer-shehane merged 1 commit intoMay 2, 2025
Merged
Conversation
Collaborator
|
jennifer-shehane
approved these changes
May 2, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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-testsuses regular action parametersThe follow-on job
all-testsuses the action with a CLI commandAssessment
The
commandparameter uses a CLI command to run the action, which by-passes the Module API.Best practice is however to use non-
commandparameters.Each of the CLI options can be used with action parameters, so there is no necessity to use the
commandparameter.Change
all-testsjob to use action parameters other thancommand. Suppress the job summary withpublish-summary: falsebecause 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/runsRemove the reference to the outdated blog article from the year 2019.
Remove the icons for consistency with other workflows.
Reduce
all-testsjob 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.