Release: Ensure we are publishing the correct versions of CT related npm packages for upcoming 10.0 release

[sync-by-unito]

Summary

With the upcoming 10.0-release, we need to ensure any CT related packages are published with a breaking change in conjunction with the release of 10.0 itself. Our documentation shows the use of custom functions that would require users to download the dev-servers as an npm dependency rather than relying on what is shipped in the binary so the publishing of these packages is mandatory.

We are releasing a new package called @cypress/vue2. This was previously released under the @cypress/vue@2 tag, but we split this package out.

Packages + versions:

• @cypress/mount-utils: 2.0.0
• @cypress/react: 6.0.0
• @cypress/vue: 4.0.0
• @cypress/vue2: 1.0.0 (New Package)
• @cypress/webpack-dev-server: 2.0.0
• @cypress/vite-dev-server: 3.0.0

Since we added a breaking change to @cypress/mount-utils, this necessitates a breaking change for all mount libraries.

To facilitate the breaking changes, we will need to push a commit to these packages with BREAKING CHANGE in the footer of the commit message for our semver to properly publish the new versions. Since we have new packages we are publishing and we did a drastic overhaul of the dev-servers, we should ensure that these packages are properly configured so as to facilitate their publish when we push a commit that enables their publishing.

Updates from Slack Convo:

• Engineering will investigate the deps being present for independent release (eslint rule?).
  • https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-extraneous-dependencies.md
  • https://github.com/import-js/eslint-plugin-import
• Engineering will work towards releasing the packages as rc.
• Engineering will each independently released package to ensure they’re working.
• Engineering will publish the packages as non-rc after we verify it’s working.
• DX will add an example of using the external packages and why in the Docs.

Future considerations: Since we are bundling these packages in the binary, any breaking changes will result in a breaking change for Cypress. We should ensure that our current system for handling breaking changes works when we make breaking changes to the packages located in npm. Probably doesn't need to be figured out now but just wanted to note this.

There might not be too much work here, but it is important that we are ready and decided on what we are publishing and align it with the 10.0 release.

Slack thread with full convo:

https://cypressio.slack.com/archives/C01TQQCQLJY/p1652902314617969

Acceptance Criteria

• Should publish breaking change for all CT related packages
• Should NOT publish packages until 10.0 has been released
• Ensure semantic-release is working correctly for all packages (changelogs etc…)

Resources

Any Notion documents, Google documents, Figma Boards

┆Issue is synchronized with this Jira Task by Unito
┆author: Zach Williams
┆epic: CT Architecture
┆friendlyId: UNIFY-1773
┆priority: Highest
┆sprint: Unification Release Sprint
┆taskType: Task

[sync-by-unito]

➤ Zach Williams commented:

The changelog for @cypress/webpack-dev-server got removed so need to add that back in

[sync-by-unito]

➤ Emily Rohrbough commented:

• support new devServer API feat: add new webpack-dev-server package based on object API & bundling #20861 ( https://github.com/cypress-io/cypress/pull/20861|smart-link )
  • add next preset feat: add next preset to webpack-dev-server-fresh #21069 ( https://github.com/cypress-io/cypress/pull/21069|smart-link )
  • dropped next 10 support - create react app reset feat: add create-react-app handler #20954 ( https://github.com/cypress-io/cypress/pull/20954|smart-link ) -- lift & shift from cypress/react/plugins. Is this deprecated?
  • nuxt support feat: vue-cli and nuxt preset for CT object API architecture #20956 ( https://github.com/cypress-io/cypress/pull/20956|smart-link ) and fix: remove asset size warnings and enable nuxt e2e tests #21074 ( https://github.com/cypress-io/cypress/pull/21074|smart-link )
  • remove webpack performance details from webpack output
  • add vue cli support \20956 ( feat: vue-cli and nuxt preset for CT object API architecture #20956 )feat: vue-cli and nuxt preset for CT object API architecture #20956 ( feat: vue-cli and nuxt preset for CT object API architecture #20956 )
  • add vue cli 5 support \20413 ( feat(launchpad): support for Vue CLI 5 #20413 )(feat(launchpad): support for Vue CLI 5 #20413 ( https://github.com/cypress-io/cypress/pull/20413|smart-link )

cypress-react:- Dropped create-react-app plugins support #20954 ( https://github.com/cypress-io/cypress/pull/20954|smart-link )

[sync-by-unito]

➤ Chris Baus commented:

Ensure all dependencies are including in package.json prior to publish.