Skip to content

Commit

Permalink
Merge pull request cypress-io#19802 from cypress-io/update-release-guide
Browse files Browse the repository at this point in the history
  • Loading branch information
jennifer-shehane committed Jan 25, 2022
2 parents 246db9b + 801246e commit e952f0e
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion guides/release-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,13 @@ of Cypress. You can see the progress of the test projects by opening the status

![Screenshot of status checks](https://i.imgur.com/AsQwzgO.png)

Once the `develop` branch for all test projects are reliably passing with the new changes, publishing can proceed.
#### :bangbang: Important :bangbang:

The `linux x64`, `win32 x64`, and `darwin x64` artifacts produced by CI are all placed in the same directory on the CDN. The version that was built last will overwrite the other versions in the directory. Until work is done to complete [#19771](https://github.com/cypress-io/cypress/issues/19771), you must ensure that the `linux` workflow publishes its artifacts **after** the `windows`/`mac` workflows. To guarantee this, you can re-run the `create-build-artifacts` job for the `linux` workflow within CircleCI after the initial builds have completed.

<img src="https://user-images.githubusercontent.com/1711637/150612076-ac1d233b-519a-443b-9fd4-950a8f0439ef.png" width="250" height="auto">

Once the `develop` branch for all test projects are reliably passing with the new changes and the `linux` binary is present at `https://cdn.cypress.io/beta/npm/X.Y.Z/<sha>/cypress.tgz`, publishing can proceed.

### Steps to Publish a New Version

Expand All @@ -89,6 +95,7 @@ In the following instructions, "X.Y.Z" is used to denote the [next version of Cy
![commit-link](https://user-images.githubusercontent.com/1157043/80608728-33fe6100-8a05-11ea-8b53-375303757b67.png)
2. Scroll down past the changes to the comments. The first comment should be a `cypress-bot` comment that includes a line beginning `npm install ...`. Grab the `https://cdn.../npm/X.Y.Z/<long sha>/cypress.tgz` link.
![cdn-tgz-link](https://user-images.githubusercontent.com/1157043/80608736-3791e800-8a05-11ea-8d75-e4f80128e857.png)
- Make sure the linux binaries are present at that location. See [Before Publishing a New Version](#before-publishing-a-new-version).
- Publish to the npm registry straight from the URL:

```shell
Expand All @@ -107,6 +114,8 @@ In the following instructions, "X.Y.Z" is used to denote the [next version of Cy
- Run a quick, manual smoke test:
- `cypress open`
- Go into a project, run a quick test, make sure things look right
- Install the new version into an established project and run the tests there
- [cypress-realworld-app](https://github.com/cypress-io/cypress-realworld-app) uses yarn and represents a typical consumer implementation.
- Optionally, do more thorough tests:
- Trigger test projects from the command line (if you have the appropriate permissions)

Expand Down

0 comments on commit e952f0e

Please sign in to comment.