Skip to content

Commit

Permalink
Update DEPLOY.md (#5554)
Browse files Browse the repository at this point in the history
* Update DEPLOY.md

- Document kitchensink release process better
- Clarify pushing up the release commit

* Update DEPLOY.md

Co-Authored-By: Jennifer Shehane <[email protected]>

* Update DEPLOY.md

Co-Authored-By: Jennifer Shehane <[email protected]>

* Update DEPLOY.md

Co-Authored-By: Jennifer Shehane <[email protected]>
  • Loading branch information
flotwig and jennifer-shehane authored Oct 31, 2019
1 parent 82ffca9 commit 696e085
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions DEPLOY.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@ Once all test projects are reliably working with new changes, publishing can pro
### Steps to Publish a New Version
0. Make sure that if there is a new [`cypress-example-kitchensink`][https://github.com/cypress-io/cypress-example-kitchensink/releases] version, the corresponding dependency in `packages/example` has been updated to that new version.
1. Make sure that you have the correct environment variables set up before proceeding.
- You'll need Cypress AWS access keys in `aws_credentials_json`, which looks like this:
```text
Expand Down Expand Up @@ -144,15 +145,17 @@ Once all test projects are reliably working with new changes, publishing can pro
```
npm run binary-release -- --version 3.4.0 --commit`
```
9. Tag the current commit with `v3.4.0` and push that tag up.
10. If needed, push out the updated changes to the docs manifest to `on.cypress.io`.
11. If needed, push out an updated kitchen sink.
12. Close the release in [ZenHub](https://app.zenhub.com/workspaces/test-runner-5c3ea3baeb1e75374f7b0708/reports/release).
13. Bump `version` in `package.json` from `develop` branch and then merge into `master`.
14. Using [cypress-io/release-automations][release-automations]:
9. If needed, push out any updated changes to the links manifest to [`on.cypress.io`](https://github.com/cypress-io/cypress-services/tree/develop/packages/on).
10. If needed, deploy the updated [`cypress-example-kitchensink`][cypress-example-kitchensink] to `example.cypress.io` by following [these instructions under "Deployment"](./packages/example/README.md).
11. Close the release in [ZenHub](https://app.zenhub.com/workspaces/test-runner-5c3ea3baeb1e75374f7b0708/reports/release).
12. Bump `version` in `package.json` and commit it to `develop` using a commit message like `release 3.4.0 [skip ci]`
13. Tag this commit with `v3.4.0` and push that tag up.
14. Merge `develop` into `master` and push that branch up.
15. Using [cypress-io/release-automations][release-automations]:
- Publish GitHub release to [cypress-io/cypress/releases](https://github.com/cypress-io/cypress/releases) using package `set-releases` (see its README for details).
- Add a comment to each GH issue that has been resolved with the new published version using package `issues-in-release` (see its README for details)
Take a break, you deserve it! :sunglasses:
[release-automations]: https://github.com/cypress-io/release-automations
[cypress-example-kitchensink]: https://github.com/cypress-io/cypress-example-kitchensink

4 comments on commit 696e085

@cypress-bot
Copy link
Contributor

@cypress-bot cypress-bot bot commented on 696e085 Oct 31, 2019

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.

You can install this pre-release platform-specific build using instructions at https://on.cypress.io/installing-cypress#Install-pre-release-version.

You will need to use custom CYPRESS_INSTALL_BINARY url and install Cypress using an url instead of the version.

export CYPRESS_INSTALL_BINARY=https://cdn.cypress.io/beta/binary/3.6.0/linux-x64/circle-develop-696e0852716e976f5abdfd9c21d165db889d7873-180435/cypress.zip
npm install https://cdn.cypress.io/beta/npm/3.6.0/circle-develop-696e0852716e976f5abdfd9c21d165db889d7873-180428/cypress.tgz

@cypress-bot
Copy link
Contributor

@cypress-bot cypress-bot bot commented on 696e085 Oct 31, 2019

Choose a reason for hiding this comment

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

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

You can install this pre-release platform-specific build using instructions at https://on.cypress.io/installing-cypress#Install-pre-release-version.

You will need to use custom CYPRESS_INSTALL_BINARY url and install Cypress using an url instead of the version.

set CYPRESS_INSTALL_BINARY=https://cdn.cypress.io/beta/binary/3.6.0/win32-x64/appveyor-develop-696e0852716e976f5abdfd9c21d165db889d7873-28531096/cypress.zip
npm install https://cdn.cypress.io/beta/binary/3.6.0/win32-x64/appveyor-develop-696e0852716e976f5abdfd9c21d165db889d7873-28531096/cypress.zip

@cypress-bot
Copy link
Contributor

@cypress-bot cypress-bot bot commented on 696e085 Oct 31, 2019

Choose a reason for hiding this comment

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

AppVeyor has built the win32 ia32 version of the Test Runner.

You can install this pre-release platform-specific build using instructions at https://on.cypress.io/installing-cypress#Install-pre-release-version.

You will need to use custom CYPRESS_INSTALL_BINARY url and install Cypress using an url instead of the version.

set CYPRESS_INSTALL_BINARY=https://cdn.cypress.io/beta/binary/3.6.0/win32-ia32/appveyor-develop-696e0852716e976f5abdfd9c21d165db889d7873-28531096/cypress.zip
npm install https://cdn.cypress.io/beta/binary/3.6.0/win32-ia32/appveyor-develop-696e0852716e976f5abdfd9c21d165db889d7873-28531096/cypress.zip

@cypress-bot
Copy link
Contributor

@cypress-bot cypress-bot bot commented on 696e085 Oct 31, 2019

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.

You can install this pre-release platform-specific build using instructions at https://on.cypress.io/installing-cypress#Install-pre-release-version.

You will need to use custom CYPRESS_INSTALL_BINARY url and install Cypress using an url instead of the version.

export CYPRESS_INSTALL_BINARY=https://cdn.cypress.io/beta/binary/3.6.0/darwin-x64/circle-develop-696e0852716e976f5abdfd9c21d165db889d7873-180444/cypress.zip
npm install https://cdn.cypress.io/beta/npm/3.6.0/circle-develop-696e0852716e976f5abdfd9c21d165db889d7873-180442/cypress.tgz

Please sign in to comment.