Skip to content

Commit

Permalink
docs: adds repository checkout prereqs and green build tips to releas…
Browse files Browse the repository at this point in the history
…e guide (#27266)

Co-authored-by: Mark Noonan <[email protected]>
  • Loading branch information
cacieprins and marktnoonan committed Aug 7, 2023
1 parent 4f546f2 commit b170431
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions guides/release-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,13 @@ The `@cypress/`-namespaced NPM packages that live inside the [`/npm`](../npm) di
CF_TOKEN="..."
```

- Ensure that you have the following repositories checked out locally and ready to contribute to:
- [`cypress-realworld-app`](https://github.com/cypress-io/cypress-realworld-app)
- [`cypress-documentation`](https://github.com/cypress-io/cypress-documentation)
- [`cypress-docker-images`](https://github.com/cypress-io/cypress-docker-images)
- [cypress-io/release-automations][release-automations]


If you don't have access to 1Password, ask a team member who has done a deploy.

Tip: Use [as-a](https://github.com/bahmutov/as-a) to manage environment variables for different situations.
Expand Down Expand Up @@ -87,6 +94,10 @@ _Note: It is advisable to notify the team that the `develop` branch is locked do
- Follow the writing the [Cypress Changelog release steps](./writing-the-cypress-changelog.md#release) to update the [`cli/CHANGELOG.md`](../cli/CHANGELOG.md).

4. Once the `develop` branch is passing in CI and you have confirmed the `cypress-bot` has commented on the commit with the pre-release versions for `darwin-x64`, `darwin-arm64`, `linux-x64`,`linux-arm64`, and `win32-x64`, publishing can proceed.
Tips for getting a green build:
- If the `windows` workflow is failing with timeout errors, you can retry from the last failed step.
- Sometimes a test can get stuck in a failing state between attempts on the `windows` workflow. In these cases, kicking off a full run of the workflow can help get it into a passing state.
- If the `linux-x64` workflow fails due to a flaky test but percy finalizes the build, you *must* restart the workflow from the failed steps. Restarting the entire workflow after a finalized Percy build can cause Percy to fail the next attempt with a "Build has already been finalized" error, requiring pushing a new commit to start fresh.

5. Log into AWS SSO with `aws sso login --profile <name_of_profile>`. If you have setup your credentials under a different profile than `prod`, be sure to set the `AWS_PROFILE` environment variable to that profile name for the remaining steps. For example, if you are using `production` instead of `prod`, do `export AWS_PROFILE=production`.

Expand Down

5 comments on commit b170431

@cypress-bot
Copy link
Contributor

@cypress-bot cypress-bot bot commented on b170431 Aug 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Circle has built the linux x64 version of the Test Runner.

Learn more about this pre-release build at https://on.cypress.io/advanced-installation#Install-pre-release-version

Run this command to install the pre-release locally:

npm install https://cdn.cypress.io/beta/npm/12.17.4/linux-x64/develop-b17043102bcb7bb653efb6526238468c74b4d564/cypress.tgz

@cypress-bot
Copy link
Contributor

@cypress-bot cypress-bot bot commented on b170431 Aug 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Circle has built the linux arm64 version of the Test Runner.

Learn more about this pre-release build at https://on.cypress.io/advanced-installation#Install-pre-release-version

Run this command to install the pre-release locally:

npm install https://cdn.cypress.io/beta/npm/12.17.4/linux-arm64/develop-b17043102bcb7bb653efb6526238468c74b4d564/cypress.tgz

@cypress-bot
Copy link
Contributor

@cypress-bot cypress-bot bot commented on b170431 Aug 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Circle has built the darwin x64 version of the Test Runner.

Learn more about this pre-release build at https://on.cypress.io/advanced-installation#Install-pre-release-version

Run this command to install the pre-release locally:

npm install https://cdn.cypress.io/beta/npm/12.17.4/darwin-x64/develop-b17043102bcb7bb653efb6526238468c74b4d564/cypress.tgz

@cypress-bot
Copy link
Contributor

@cypress-bot cypress-bot bot commented on b170431 Aug 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Circle has built the win32 x64 version of the Test Runner.

Learn more about this pre-release build at https://on.cypress.io/advanced-installation#Install-pre-release-version

Run this command to install the pre-release locally:

npm install https://cdn.cypress.io/beta/npm/12.17.4/win32-x64/develop-b17043102bcb7bb653efb6526238468c74b4d564/cypress.tgz

@cypress-bot
Copy link
Contributor

@cypress-bot cypress-bot bot commented on b170431 Aug 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Circle has built the darwin arm64 version of the Test Runner.

Learn more about this pre-release build at https://on.cypress.io/advanced-installation#Install-pre-release-version

Run this command to install the pre-release locally:

npm install https://cdn.cypress.io/beta/npm/12.17.4/darwin-arm64/develop-b17043102bcb7bb653efb6526238468c74b4d564/cypress.tgz

Please sign in to comment.