Skip to content

Commit

Permalink
docs: add more details to the @packages/example deploy process (#29136)
Browse files Browse the repository at this point in the history
* docs: add more details to the @packages/example deploy process

* Update guides/release-process.md

Co-authored-by: Jennifer Shehane <jennifer@cypress.io>

---------

Co-authored-by: Jennifer Shehane <jennifer@cypress.io>
  • Loading branch information
cacieprins and jennifer-shehane committed Mar 14, 2024
1 parent 9f1ef29 commit 85b85dd
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
6 changes: 5 additions & 1 deletion guides/release-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ _Note: It is advisable to notify the team that the `develop` branch is locked do
3. Create a Release PR -
Bump, submit, get approvals on, and merge a new PR. This PR should:
- Bump the Cypress `version` in [`package.json`](package.json)
- Bump the [`packages/example`](../packages/example) dependency if there is a new [`cypress-example-kitchensink`](https://github.com/cypress-io/cypress-example-kitchensink/releases) version
- Bump the [`packages/example`](../packages/example) dependency if there is a new [`cypress-example-kitchensink`](https://github.com/cypress-io/cypress-example-kitchensink/releases) version, and `yarn` to ensure the lockfile is up to date.
- 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.
Expand Down Expand Up @@ -162,6 +162,10 @@ _Note: It is advisable to notify the team that the `develop` branch is locked do
15. Merge the documentation PR from step 11 and the new docker image PR created in step 12 to release the image.

16. 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).
- Build `@packages/example` with `yarn workspace @packages/example build`

This comment has been minimized.

Copy link
@MikeMcC399

MikeMcC399 Mar 15, 2024

Contributor

I've noticed that running yarn from the root of the repo, automatically runs yarn workspace @packages/example build.

- Inspect the contents of `./packages/example/build` before deploying, and ensure it looks correct
- Run `yarn workspace @packages/example deploy`. This adds changes from `cypress-example-kitchensink` to a commit in the `gh-pages` branch, which will deploy to production with its own CI.
- Check the deployed site at `https://example.cypress.io` to ensure the new changes deployed correctly.

17. Once the release is complete, create a Github tag off of the release commit which bumped the version:
```shell
Expand Down
2 changes: 2 additions & 0 deletions packages/example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ This copies the `cypress/e2e` and files from [`cypress-example-kitchensink`](htt

## Deploying

This command deploys directly to production! Before executing it, ensure everything looks correct in the `./build` directory.

```bash
yarn workspace @packages/example deploy
```

5 comments on commit 85b85dd

@cypress-bot
Copy link
Contributor

@cypress-bot cypress-bot bot commented on 85b85dd Mar 14, 2024

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/13.7.1/linux-x64/develop-85b85dded8429030ac1de0632b95f73a7707fbde/cypress.tgz

@cypress-bot
Copy link
Contributor

@cypress-bot cypress-bot bot commented on 85b85dd Mar 14, 2024

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/13.7.1/linux-arm64/develop-85b85dded8429030ac1de0632b95f73a7707fbde/cypress.tgz

@cypress-bot
Copy link
Contributor

@cypress-bot cypress-bot bot commented on 85b85dd Mar 14, 2024

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/13.7.1/darwin-x64/develop-85b85dded8429030ac1de0632b95f73a7707fbde/cypress.tgz

@cypress-bot
Copy link
Contributor

@cypress-bot cypress-bot bot commented on 85b85dd Mar 14, 2024

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/13.7.1/win32-x64/develop-85b85dded8429030ac1de0632b95f73a7707fbde/cypress.tgz

@cypress-bot
Copy link
Contributor

@cypress-bot cypress-bot bot commented on 85b85dd Mar 14, 2024

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/13.7.1/darwin-arm64/develop-85b85dded8429030ac1de0632b95f73a7707fbde/cypress.tgz

Please sign in to comment.