mirror of
https://github.com/cypress-io/cypress.git
synced 2026-05-03 05:20:38 -05:00
docs: update internal docs for monorepo (#8688)
Co-authored-by: Jessica Sachs <jess@jessicasachs.io>
This commit is contained in:
+28
-4
@@ -264,7 +264,9 @@ Working on your first Pull Request? You can learn how from this free series [How
|
||||
|
||||
Cypress is a large open source project. When you want to contribute to Cypress, you may be unsure which part of the project to work within.
|
||||
|
||||
This repository is made up of various packages. They are discrete modules with different responsibilities, but each is necessary for the Cypress app and is not necessarily useful outside of the Cypress app.
|
||||
Cypress uses a monorepo, which means there are many independent packages in this repository. There are two main types of packages: private and public.
|
||||
|
||||
Private packages generally live within the [`packages`](./packages) directory and are in the `@packages/` namespace. These packages are combined to form the main Cypress app that you get when you `npm install cypress`. They are discrete modules with different responsibilities, but each is necessary for the Cypress app and is not necessarily useful outside of the Cypress app. Since these modules are all compiled and bundled into a binary upon release, they are sometimes collectively referred to as the Cypress binary.
|
||||
|
||||
Here is a list of the core packages in this repository with a short description, located within the [`packages`](./packages) directory:
|
||||
|
||||
@@ -285,8 +287,16 @@ Here is a list of the core packages in this repository with a short description,
|
||||
| [socket](./packages/socket) | `@packages/socket` | A wrapper around socket.io to provide common libraries. |
|
||||
| [static](./packages/static) | `@packages/static` | Serves static assets used in the Cypress GUI. |
|
||||
| [ts](./packages/ts) | `@packages/ts` | A centralized version of typescript. |
|
||||
|
||||
Public packages live within the [`npm`](./npm) folder and are standalone modules that get independently published to npm under the `@cypress/` namespace. These packages generally contain extensions, plugins, or other packages that are complementary to, yet independent of, the main Cypress app.
|
||||
|
||||
We try to tag all issues with a `pkg/` tag describing the appropriate package the work is required in. For example, the [`pkg/driver`](https://github.com/cypress-io/cypress/labels/pkg%2Fdriver) label is tagged on issues that require work in the `driver` package.
|
||||
Here is a list of the npm packages in this repository:
|
||||
|
||||
| Folder Name | Package Name | Purpose |
|
||||
| :----------------------------------------------------- | :--------------------------------- | :--------------------------------------------------------------------------- |
|
||||
| [webpack-preprocessor](./npm/webpack-preprocessor) | `@cypress/webpack-preprocessor` | Cypress preprocessor for bundling JavaScript via webpack. |
|
||||
|
||||
We try to tag all issues with a `pkg/` or `npm/` tag describing the appropriate package the work is required in. For public packages, we use their qualified package name: For example, issues relating to the webpack preprocessor are tagged under [`npm: @cypress/webpack-preprocessor`](https://github.com/cypress-io/cypress/labels/npm%3A%20%40cypress%2Fwebpack-preprocessor) label and issues related to the `driver` package are tagged with the [`pkg/driver`](https://github.com/cypress-io/cypress/labels/pkg%2Fdriver) label.
|
||||
|
||||
### Requirements
|
||||
|
||||
@@ -532,8 +542,22 @@ They will outline development and test procedures. When in doubt just look at th
|
||||
|
||||
The repository is setup with two main (protected) branches.
|
||||
|
||||
- `master` is the code already published in the last Cypress version.
|
||||
- `develop` is the current latest "pre-release" code. This branch is set as the default branch, and all pull requests should be made against this branch.
|
||||
- `master` is the code already published, both for the main Cypress app and independent npm packages.
|
||||
- `develop` is the current latest "pre-release" code. This branch is set as the default branch, and all pull requests that update the main Cypress binary should be made against this branch.
|
||||
|
||||
In general, we want to publish our standalone npm packages continuously as new features are added. Therefore, any pull requests that only change independent `@cypress/` packages in the [`npm`](./npm) directory should be made directly off the `master` branch. We use [`semantic-release`](https://semantic-release.gitbook.io/semantic-release/) to automatically publish these packages to npm when a PR is merged directly into master.
|
||||
|
||||
When updating the main Cypress app, pull requests should be made against the `develop` branch. We do not continuously deploy the Cypress binary, so `develop` contains all of the new features and fixes that are staged to go out in the next update of the main Cypress app. In addition, if you make changes to an npm package that can't be published until the binary is also updated, you should make a pull request against the `develop` branch.
|
||||
|
||||
Essentially, if you only change files within the [`npm`](./npm) folder, then you should make a pull request against `master`. Otherwise, make it against `develop`.
|
||||
|
||||
All updates to `master` are automatically merged into `develop`, so `develop` always has the latest version of every package.
|
||||
|
||||
#### Workflow Diagrams
|
||||
|
||||
<img src="https://viewer.diagrams.net/?highlight=0000ff&edit=_blank&layers=1&nav=1&title=git-workflow.drawio#R7Vxtc5s4EP41zNx9cIcXg%2BFj4sRtZy53ncvdpO03GYRNgxEVchL313cFEu%2BOcWxMJvGXFFZiJfZ5dtGu5CrGdPX0kaJ4eUM8HCq66j0pxpWi65apwl8u2GSCsWlmggUNvEykFoLb4BfOhJqUrgMPJ0KWiRghIQviqtAlUYRdVpEhSsljtZtPQq8iiNECNwS3Lgqb0rvAY8tMasvX4vJPOFgs5ciaKlpWSHYWgmSJPPJYEhnXijGlhLDsavU0xSG3XdUusy2t%2BcQojliXB34GxL69cOin%2Bafvn7%2Bz%2F%2F%2BZfDRHmj7J9DygcC1eWUyXbaQNKFlHHuZqVMW4fFwGDN%2FGyOWtjwA6yJZsFcKdBpdCHaYMP22dqZa%2FP%2FAGkxVmdANd5ANO9oSkjG1k948FAGNTaF2WjG8YlgBegL7IVRd2gQthmj3MZOoNK92iVQwG0tU7Qu%2F9EJDl7KLw9%2B8vN%2BnruvdAjqRhTbALq5oMhcEigmsX7IMpCLj1AuDghWhYBZ7HH7%2BkOAl%2BoXmqimMRkyBi6cual4p5xXWtGUkyL%2BKqfRKxGVoFIbflf2hJVkhIhatpFlebA3wkBJ0ago7WQFCfqE0Epa8cH8Bxk%2BYzVXFmCkztwlaudcVWFftKCnXl8nIP5ELss6PjJhAy1a04Hh03w67gZppN3Npgm%2FQGm9kSnayQCYtU4LF%2BrolsGGWmvIAO2jh%2BKhrhasH%2FnUInGszB6FQqhAlmOrMerwR9bTwc%2BuMm%2Bs4pndY5Avo6oJ%2FCXiPAHeIQ8MVE%2Bq2%2B55Ec8XXEEkVp1E5bssHm9KChlLHqbmIgAWidPeI5%2FzKM4D6mxAXhq2egPhgDLb3JQK2NgkZfFNTkDFo4SMLDaCHUhMFBaqZL7N5zvpI194gblPA1RMEorv6oA94UzjKnKHKXCg8AstcMI7amvINWebS36VyR1FsTAJwTBRZjfY42pfB%2B6YD8%2Fb%2F8y42AEnABsL%2Fvp39PAsLdEkdyAgGfzgrTBZ%2FGVEJDWOo3KcXTxtK8VPB%2BHveu8AMOSdznRD9ze7AlTikRSMPJCUHW5ocBpG35vIs3clNTe89ODoTcCzvHy4RRco%2BnJISga1xFJOLB0Qcj1URd42pbLrR7ya33suSuRs5Jy4rbaomceb7aQ%2BhsJk0NiBZgh7i7OUSWL75kSr706G4m3awaqm2Ro8uJVj4x5qQvQ2nGbkPhyLvg5YyCow1ay%2FqE0YmEfF0JSmc8QmSLAhzOU%2F2S7VzkLfCtmAShbEkWJELhdSG9xE8B%2B8oVfDDF3TcxKX599SR185uNuCk7nKIbvu%2FrrtvwTmjxrLll8gTVXdOHGjv41La6ynOEbFKjBL3Z4iJSRnGIWPBQHbWNDWKEL3yRVVrbjD%2BYVerVPC8ha%2Bpi8VS5kLNLUUMTQxBeWUNTys78vQ8hbEs2%2FY4I65nY9sZthLX1uWG9FcJq1qRCs3qW35WvoKdGWE3rRlggENqUuom05bkZ10Zy1D2nVn0ALrI5HNl%2F2pKK9%2BM%2Fvo%2BtLQF%2F4sxV9cj%2Bw5MDztRnetqTQR1Nq7PwpZ8Gp67o1J8GucRsSZdBtSiw0ASzSjKxZv7I3p4hJzGKWpMQN2MOT0DoYv6HmqUR8p8%2FUxVqmqn4wjV4Vya9QzbWioWlhmxE3hIRuko9RLY9Ch7wxnHKWbgIMYMEawQTdoNo0XySZySjAFa6kXhSleOlLQzy6cSH%2FvLJ1O%2BztNaras0fnCP3fpEun0c1c%2BhjO7OEPnbEhSmN4gVJHCJhkCAKAzmSHxLEasM3KwC19DYD6PksbMe2UbeS5x47JfvnV%2Ft9g%2BUGpy49bkeNvLcSlbW9QrWH4xS%2BU7iPrm7xIFCEVnHaaBgcLeFSdXFVQ70mrz7raZXmurPpu%2F1Ndml1uUpjm9fJDu2OJ1t3%2BJ5acj%2B15IHy8TYnzF%2B75ofNulejdvMevXAop5t0qG2AmiBOtpWJylbfkg93W9M10NieRp8qKOrVRYhEoVxiOeU%2B0qRLunoGS3zQhgarbdPvDFY7WM7QYFlnsDqDpekDo2WfP1p7oGUOjVaXXYEzWkKtPTRa5zVGd7Ty072DoXVeZOyB1nhotDqcUX45WqIWfTS0ZAn7VGjZ9Zrv0OmWbZ%2Fh2gOuoRMu2znDtQdcQ6dcmmY14dm5a%2FdjvYplD1HXLzr%2BRUgsDPkDM7YRkPAjoVV0wZR087V8w%2Ff%2BxE4gvy22%2F9K7TX5X38usbkS%2BdDvz1e8rSrJku27PdMwS6SYLO%2B8sHnbQum3X7hwCtoWAwRN5p8v5gTNeryaVd3otvLw9vIZO5p1eSy9vDq%2FB03mn1%2BLL28Nr6IQ%2BP3R%2BPrPwrs4sVH8c9J7PLUg9xuDHhzS1x8VJflL6WMEzP2B9MoTM11av0TSzic%2FJCgD9JPIvLSwMezC%2FQwFAU8VScmcFwFHbeXj4If5t2VDvh%2B814xSH6dUeF%2BtvMX4NXsBUuxSc%2B%2Fn1g4gypcDyrRJXtpYvD%2F3VxNCBamf4EcuAwX4CodZpOq7xr%2BtPIEbGSwPe7ogEt8X%2F15R1L%2F7TK%2BP6Nw%3D%3D"/>
|
||||
|
||||
<img src="https://viewer.diagrams.net/?highlight=0000ff&edit=_blank&layers=1&nav=1&title=git-2.drawio#RzVltc9o4EP41%2FtiO38EfgYS2c%2B1NrulMm4%2FCFrYutuXIcsD3629lS%2Fg9QBpCYQBrLa2l3WefXQnNWiX7Twxl0Tca4Fgz9WCvWTeaaRqW68KPkJS1xHOkIGQkkJ0awT35D0uhLqUFCXDe6cgpjTnJukKfpin2eUeGGKO7brctjbtPzVCIB4J7H8VD6U8S8KiWzh29kX%2FGJIzUkw1d3kmQ6iwFeYQCumuJrFvNWjFKeX2V7Fc4FsZTdqnHrSfuHibGcMpPGfDX0%2B33z%2Ff7X1m42j39mH%2F6JzazD1LLM4oLuWA5WV4qCzBapAEWSnTNWu4iwvF9hnxxdwc%2BB1nEkxhaBlxKdZhxvJ%2Bcp3FYPcAG0wRzVkIXNcCrR5TKonVz11jfsma1LGpZ3lbAQtLj4UFzYxS4kHY5w0ZDk%2BAAMCKblPGIhjRF8W0jXTbSr5Rm0jj%2FYs5LCXFUcNo13ZamfI0SEouF%2F0ARTRBI%2FYI9V8ZvrCuefq5tGY4RJ8%2FdcWOWkkPvKAGNjU%2Fm849O1y1zvauEIxZiLse1YXhcldNTldOC%2BXigasEYKlvdMtEhP2vSrn7u3Loj4KKeRYOmg5FfDzBrJAjdGBy6zDOUdqDnPhWCLyqwfMgrKC2gg2Fk%2B%2BYmXIXidxWhNATyFMFTzSKk8EULsWIi9FZxhfGj4M%2FSh0eYsABdPbxQejYMpX4khm631Td83eBnHAOyZV9Y96F7S1bPX4l7UXSESsbjYQsrWdGYskqHtd1uTd8XluKMPuLWncDduEAJ1rLhrzciKMvqgcRSnN%2FiKEPRfpuj3B7Q34yi7CsgaBdhofnuu5ic6JJgYIDgNAx9QznH7Prowe4EembeRtcvgR6Ayx8HH%2Bd9MhxYiJW%2FRCEBFpDNB1lXVI2bfadVytYJmRHvCa81z2eObD80T4JWo1s0ylbjDjMCdsRMyk7NsmCwKlG9YFhZytS58Vj8%2Fm7WPjc%2Fmvash0TTNl7Mj%2Ba8j93eiMvkR3eS3QQyquJfBW5DYBBV4jXktAfBZweOqTVMcIzAwFe0gS1NB8coJmEK1z7gQaBmKQiBwJ5hIW8kJAiqIGEYGBZtKn0CWtIloNxZas6NXEGLd5yVeL%2FENHKjI5Vqh%2B1FG57TQT5JS%2FpHw%2Fa6lbeihdfWjqoLMH6OudYnqTcAxuydeOtALobb5ZbzyeWCHHgF3rKuwVveERI6YYD3DlX9fMBaf9NrMcwQOSfWNa9mm9kRttFNddRQdh74mxtVdaChlJofHbur43Js5A0cvmBY1MVi4b6qpOvMs2Eq6eQ%2BzUTVrHNa2dV%2FRKP9SJqTAKvtF4%2FwsItfZgAHGLtOs0SrD7sEetZD2MUxyXKBnzxCmRD6MS2Cer%2FgkzQEiXn8tOe0ItsR77Ei261ewyRYvy5RfHuTxxjt2ns2UnsbxqWKb6W4hZufEa6QEwhIfIHPYfe0ZTQZcyiYhF%2BOQkRKrLeKL7kdpDKFGhfZdw9pfMR33ojvzIu5buT4dK1r3lpb2Jpnr2i6LXJhgvUwWL%2BIMC4hEbfJQfer3foOEcFpfEflAY24tUE5riM%2FmTiKOYqJbgSmNMW9cJWi07EzRhBXgoc72Fd7Q3yY9gg%2BZhfDhzmFD8%2FQFp52a2rAP%2FMbJTS15XAT8u6hLb3kTJedb%2B47w%2Bk7b4SXx2j5cq6bPpSVm87jR2r26JEadGJkA2Znp25Dr4UAw35HBNh9BMyGCHgjcodm87dbXf01f15at%2F8D" />
|
||||
|
||||
### Pull Requests
|
||||
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# Deployment
|
||||
|
||||
These deployment procedures mainly concern the Cypress binary and `cypress` npm module. Independent `@cypress/` packages that live inside the [`npm`](./npm) directory are automatically published to npm (with [`semantic-release`](https://semantic-release.gitbook.io/semantic-release/)) upon being merged into master.
|
||||
|
||||
Anyone can build the binary and npm package, but you can only deploy the Cypress application and publish the npm module `cypress` if you are a member of the `cypress` npm organization.
|
||||
|
||||
> :information_source: See the [publishing](#publishing) section for how to build, test and publish a
|
||||
@@ -85,14 +87,16 @@ Once the `develop` branch for all test projects are reliably passing with the ne
|
||||
|
||||
In the following instructions, "X.Y.Z" is used to denote the version of Cypress being published.
|
||||
|
||||
1. If there is a new [`cypress-example-kitchensink`](https://github.com/cypress-io/cypress-example-kitchensink/releases) version, update the corresponding dependency in [`packages/example`](./packages/example) to that new version.
|
||||
1. `develop` should contain all of the changes made in `master`. However, this occasionally may not be the case. Ensure that `master` does not have any additional commits that are not on `develop` and all auto-generated pull requests designed to merge master into develop have been successfully merged.
|
||||
|
||||
2. Use the `move-binaries` script to move the binaries for `<commit sha>` from `beta` to the `desktop` folder for `<new target version>`
|
||||
2. If there is a new [`cypress-example-kitchensink`](https://github.com/cypress-io/cypress-example-kitchensink/releases) version, update the corresponding dependency in [`packages/example`](./packages/example) to that new version.
|
||||
|
||||
3. Use the `move-binaries` script to move the binaries for `<commit sha>` from `beta` to the `desktop` folder for `<new target version>`
|
||||
```shell
|
||||
yarn move-binaries --sha <commit sha> --version <new target version>
|
||||
```
|
||||
|
||||
3. Publish the new npm package under the `dev` tag, using your personal npm account.
|
||||
4. Publish the new npm package under the `dev` tag, using your personal npm account.
|
||||
- To find the link to the package file `cypress.tgz`:
|
||||
1. In GitHub, go to the latest commit (the one whose sha you used in the last step).
|
||||

|
||||
@@ -103,13 +107,13 @@ In the following instructions, "X.Y.Z" is used to denote the version of Cypress
|
||||
npm publish https://cdn.../npm/X.Y.Z/<long sha>/cypress.tgz --tag dev
|
||||
```
|
||||
|
||||
4. Double-check that the new version has been published under the `dev` tag using `npm info cypress` or [available-versions](https://github.com/bahmutov/available-versions). `latest` should still point to the previous version. Example output:
|
||||
5. Double-check that the new version has been published under the `dev` tag using `npm info cypress` or [available-versions](https://github.com/bahmutov/available-versions). `latest` should still point to the previous version. Example output:
|
||||
```shell
|
||||
dist-tags:
|
||||
dev: 3.4.0 latest: 3.3.2
|
||||
```
|
||||
|
||||
5. Test `cypress@X.Y.Z` to make sure everything is working.
|
||||
6. Test `cypress@X.Y.Z` to make sure everything is working.
|
||||
- Install the new version: `npm install -g cypress@X.Y.Z`
|
||||
- Run a quick, manual smoke test:
|
||||
- `cypress open`
|
||||
@@ -121,7 +125,7 @@ In the following instructions, "X.Y.Z" is used to denote the version of Cypress
|
||||
```
|
||||
- Test the new version of Cypress against the Cypress dashboard repo.
|
||||
|
||||
6. Deploy the release-specific documentation and changelog in [cypress-documentation](https://github.com/cypress-io/cypress-documentation).
|
||||
7. Deploy the release-specific documentation and changelog in [cypress-documentation](https://github.com/cypress-io/cypress-documentation).
|
||||
- If there is not already a release-specific PR open, create one. You can use [`release-automations`](https://github.com/cypress-io/release-automations)'s `issues-in-release` tool to generate a starting point for the changelog, based off of ZenHub:
|
||||
```
|
||||
cd packages/issues-in-release
|
||||
@@ -131,27 +135,27 @@ In the following instructions, "X.Y.Z" is used to denote the version of Cypress
|
||||
- Merge any release-specific documentation changes into the main release PR.
|
||||
- Merging this PR into `develop` will deploy to `docs-staging` and then a PR will be automatically created against `master`. It will be automatically merged after it passes and will deploy to production.
|
||||
|
||||
7. Make the new npm version the "latest" version by updating the dist-tag `latest` to point to the new version:
|
||||
8. Make the new npm version the "latest" version by updating the dist-tag `latest` to point to the new version:
|
||||
```shell
|
||||
npm dist-tag add cypress@X.Y.Z
|
||||
```
|
||||
|
||||
8. Run `binary-release` to update the [download server's manifest](https://download.cypress.io/desktop.json) and set the next CI version:
|
||||
9. Run `binary-release` to update the [download server's manifest](https://download.cypress.io/desktop.json) and set the next CI version:
|
||||
```shell
|
||||
yarn run binary-release --version X.Y.Z
|
||||
```
|
||||
> Note: Currently, there is an [issue setting the next CI version](https://github.com/cypress-io/cypress/issues/7176) that will cause this command to fail after setting the download manifest. You will need to manually update NEXT_DEV_VERSION by logging in to CircleCI and AppVeyor. This is noted in Step 16 below.
|
||||
|
||||
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, 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. 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. Update the releases in [ZenHub](https://app.zenhub.com/workspaces/test-runner-5c3ea3baeb1e75374f7b0708/reports/release):
|
||||
12. Update the releases in [ZenHub](https://app.zenhub.com/workspaces/test-runner-5c3ea3baeb1e75374f7b0708/reports/release):
|
||||
- Close the current release in ZenHub.
|
||||
- Create a new patch release (and a new minor release, if this is a minor release) in ZenHub, and schedule them both to be completed 2 weeks from the current date.
|
||||
- Move all issues that are still open from the current release to the appropriate future release.
|
||||
|
||||
12. Bump `version` in [`package.json`](package.json), commit it to `develop`, tag it with the version, and push the tag up:
|
||||
13. Bump `version` in [`package.json`](package.json), commit it to `develop`, tag it with the version, and push the tag up:
|
||||
```shell
|
||||
git commit -am "release X.Y.Z [skip ci]"
|
||||
git log --pretty=oneline
|
||||
@@ -159,7 +163,7 @@ In the following instructions, "X.Y.Z" is used to denote the version of Cypress
|
||||
git tag -a vX.Y.Z <sha>
|
||||
git push origin vX.Y.Z
|
||||
```
|
||||
13. Merge `develop` into `master` and push both branches up.
|
||||
14. Merge `develop` into `master` and push both branches up. Note: pushing to `master` will automatically publish any independent npm packages that have not yet been published.
|
||||
```shell
|
||||
git push origin develop
|
||||
git checkout master
|
||||
@@ -167,7 +171,7 @@ In the following instructions, "X.Y.Z" is used to denote the version of Cypress
|
||||
git push origin master
|
||||
```
|
||||
|
||||
14. Inside of [cypress-io/release-automations][release-automations]:
|
||||
15. Inside of [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`:
|
||||
```shell
|
||||
cd packages/set-releases && npm run release-log -- --version X.Y.Z
|
||||
@@ -177,11 +181,11 @@ In the following instructions, "X.Y.Z" is used to denote the version of Cypress
|
||||
cd packages/issues-in-release && npm run do:comment -- --release X.Y.Z
|
||||
```
|
||||
|
||||
15. Publish a new docker image in [`cypress-docker-images`](https://github.com/cypress-io/cypress-docker-images) under `included` for the new cypress version.
|
||||
16. Publish a new docker image in [`cypress-docker-images`](https://github.com/cypress-io/cypress-docker-images) under `included` for the new cypress version.
|
||||
|
||||
16. Decide on the next version that we will work on. For example, if we have just released `3.7.0` we probably will work on `3.7.1` next. Set it on [CI machines](#set-next-version-on-cis).
|
||||
17. Decide on the next version that we will work on. For example, if we have just released `3.7.0` we probably will work on `3.7.1` next. Set it on [CI machines](#set-next-version-on-cis).
|
||||
|
||||
17. Update example projects to the new version. For most projects, you can go to the Renovate dependency issue and check the box next to `Update dependency cypress to X.Y.Z`. It will automatically create a PR. Once it passes, you can merge it. Try updating at least the following projects:
|
||||
18. Update example projects to the new version. For most projects, you can go to the Renovate dependency issue and check the box next to `Update dependency cypress to X.Y.Z`. It will automatically create a PR. Once it passes, you can merge it. Try updating at least the following projects:
|
||||
- [cypress-example-todomvc](https://github.com/cypress-io/cypress-example-todomvc/issues/99)
|
||||
- [cypress-example-todomvc-redux](https://github.com/cypress-io/cypress-example-todomvc-redux/issues/1)
|
||||
- [cypress-example-realworld](https://github.com/cypress-io/cypress-example-realworld/issues/2)
|
||||
@@ -193,7 +197,7 @@ In the following instructions, "X.Y.Z" is used to denote the version of Cypress
|
||||
- [cypress-documentation](https://github.com/cypress-io/cypress-documentation/issues/1313)
|
||||
- [cypress-example-docker-compose](https://github.com/cypress-io/cypress-example-docker-compose) - Doesn't have a Renovate issue, but will auto-create and auto-merge non-major Cypress updates as long as the tests pass.
|
||||
|
||||
18. Check if any test or example repositories have a branch for testing the features or fixes from the newly published version `x.y.z`. The branch should also be named `x.y.z`. Check all `cypress-test-*` and `cypress-example-*` repositories, and if there is a branch named `x.y.z`, merge it into `master`.
|
||||
19. Check if any test or example repositories have a branch for testing the features or fixes from the newly published version `x.y.z`. The branch should also be named `x.y.z`. Check all `cypress-test-*` and `cypress-example-*` repositories, and if there is a branch named `x.y.z`, merge it into `master`.
|
||||
|
||||
**Test Repos**
|
||||
|
||||
|
||||
Reference in New Issue
Block a user