Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: adds repository checkout prereqs and green build tips to release guide #27266

Merged
merged 2 commits into from
Aug 7, 2023
Merged

docs: adds repository checkout prereqs and green build tips to release guide #27266

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
87a95cf
docs: adds repository checkout prereqs and green build tips to releas…
cacieprins Jul 11, 2023
be7bcf4
Update guides/release-process.md
cacieprins Aug 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions guides/release-process.md
View file
Open in desktop
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