cypress-documentation

cypress-documentation copied to clipboard

Subject

Continuous Integration > GitHub Actions > Basic Setup

Description

Issue

Continuous Integration > GitHub Actions > Basic Setup advises to "Try it out".

Depending on whether the new suggested workflow main.yml is added through a push or via a PR to the master branch, the action results in 3 failures from existing workflows (for push) or 16 failed checks (for PR). The added workflow itself works correctly.

The instructions are as follows:

Try it out

To try out the example above yourself, fork the Cypress Kitchen Sink example project and place the above GitHub Action configuration in a newly created main.yml file within .github/workflows/.

Steps to reproduce

Create main.yml in master

1. Open https://github.com/cypress-io/cypress-example-kitchensink in web browser
2. Select Fork > Create a new fork
3. Take defaults, select "Create fork"
4. Select Add file > Create a new file
5. Name your file .github/workflows/main.yml.
6. Paste in contents of workflow from https://docs.cypress.io/guides/continuous-integration/github-actions#Basic-Setup
7. Click on Commit changes...
8. Take defaults (Commit directly to the master branch)
9. Click "Commit changes"

6 workflows run. 3 workflows succeed, 3 workflows fail. The failures are:

• Using Cypress GH Action
• Cypress parallel tests
• Cypress single tests

Select Actions > Cypress Tests > ... menu Disable workflow

Create main2.yml in master

1. Select <> Code
2. Select Add file > Create a new file
3. Name your file .github/workflows/main2.yml.
4. Paste in contents of workflow from https://docs.cypress.io/guides/continuous-integration/github-actions#Basic-Setup
5. Change the name to "Cypress Tests 2"
6. Click on Commit changes...
7. Select "Create a new branch for this commit and start a pull request"
8. Take the default name for the new branch
9. Click "Propose changes"
10. Click "Create pull request"
11. Click "Create pull request"
12. Note the message "Some checks were not successful"
13. Wait until all checks have completed

16 failing and 5 successful checks are reported

In addition to the workflows which fail on push to master (see above), the following PR workflows also fail:

• Add issue/PR to Triage Board
• Semantic Pull Request

Suggestion

1. [x] Temporarily remove the Try it out instructions Continuous Integration > GitHub Actions > Basic Setup
2. [x] Open one or more related issues in Cypress Kitchen Sink to address the workflow failures
3. [ ] Replace the Try it out instructions when the issues in the Cypress Kitchen Sink repo are resolved.

See the following issues for workarounds:

• https://github.com/cypress-io/cypress-example-kitchensink/issues/810
• https://github.com/cypress-io/cypress-example-kitchensink/issues/811

These steps sounds fine.

• Step 1 addressed in PR #5777