From 5000e82392eff7a4880037159d9d12d0a207c813 Mon Sep 17 00:00:00 2001 From: Emily Rohrbough Date: Wed, 21 Sep 2022 15:34:03 -0500 Subject: [PATCH 1/3] docs: list all changelogs in changelog.md & packages in contributing.md --- CHANGELOG.md | 19 ++++++++++++++++++- CONTRIBUTING.md | 7 +++++-- 2 files changed, 23 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2a007ead1b96..dc9a3d3ec3e7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1 +1,18 @@ -https://on.cypress.io/changelog + +# Changelogs + +- [Cypress App](https://on.cypress.io/changelog) +- [`@cypress/angular`](https://github.com/cypress-io/cypress/blob/develop/npm/angular/CHANGELOG.md) +- [`@cypress/create-cypress-tests`](https://github.com/cypress-io/cypress/blob/develop/npm/create-cypress-tests/CHANGELOG.md) +- [`@cypress/eslint-plugin-dev`](https://github.com/cypress-io/cypress/blob/develop/npm/eslint-plugin-dev/CHANGELOG.md) +- [`@cypress/mount-utils`](https://github.com/cypress-io/cypress/blob/develop/npm/mount-utils/CHANGELOG.md) +- [`@cypress/react`](https://github.com/cypress-io/cypress/blob/develop/npm/react/CHANGELOG.md) +- [`@cypress/react18`](https://github.com/cypress-io/cypress/blob/develop/npm/react18/CHANGELOG.md) +- [`@cypress/svelte`](https://github.com/cypress-io/cypress/blob/develop/npm/svelte/CHANGELOG.md) +- [`@cypress/vite-dev-server`](https://github.com/cypress-io/cypress/blob/develop/npm/vite-dev-server/CHANGELOG.md) +- [`@cypress/vue`](https://github.com/cypress-io/cypress/blob/develop/npm/vue/CHANGELOG.md) +- [`@cypress/vue2`](https://github.com/cypress-io/cypress/blob/develop/npm/vue2/CHANGELOG.md) +- [`@cypress/webpack-batteries-included-preprocessor`](https://github.com/cypress-io/cypress/blob/develop/npm/webpack-batteries-included-preprocessor/CHANGELOG.md) +- [`@cypress/webpack-dev-server`](https://github.com/cypress-io/cypress/blob/develop/npm/webpack-dev-server/CHANGELOG.md) +- [`@cypress/webpack-preprocessor`](https://github.com/cypress-io/cypress/blob/develop/npm/webpack-preprocessor/CHANGELOG.md) +- [`@cypress/xpath`](https://github.com/cypress-io/cypress/blob/develop/npm/xpath/CHANGELOG.md) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 241c563e3196..eb3acdc7b736 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -288,11 +288,14 @@ Here is a list of the npm packages in this repository: | [mount-utils](./npm/mount-utils) | `@cypress/mount-utils` | Common functionality for Vue/React/Angular adapters. | | [react](./npm/react) | `@cypress/react` | Cypress component testing for React. | | [react18](./npm/react18) | `@cypress/react18` | Cypress component testing for React 18. | + | [svelte](./npm/svelte) | `@cypress/svelte` | Cypress component testing for Svelte. | | [vite-dev-server](./npm/vite-dev-server) | `@cypress/vite-dev-server` | Vite powered dev server for Component Testing. | - | [webpack-preprocessor](./npm/webpack-preprocessor) | `@cypress/webpack-preprocessor` | Cypress preprocessor for bundling JavaScript via webpack. | - | [webpack-dev-server](./npm/webpack-dev-server) | `@cypress/webpack-dev-server` | Webpack powered dev server for Component Testing. | | [vue](./npm/vue) | `@cypress/vue` | Cypress component testing for Vue 3. | | [vue2](./npm/vue2) | `@cypress/vue2` | Cypress component testing for Vue 2. | + | [webpack-batteries-included-preprocessor](./npm/webpack-batteries-included-preprocessor) | `@cypress/webpack-batteries-included-preprocessor` | Cypress preprocessor for bundling JavaScript via webpack with dependencies included and support for various ES features, TypeScript, and CoffeeScript. | + | [webpack-dev-server](./npm/webpack-dev-server) | `@cypress/webpack-dev-server` | Webpack powered dev server for Component Testing. | + | [webpack-preprocessor](./npm/webpack-preprocessor) | `@cypress/webpack-preprocessor` | Cypress preprocessor for bundling JavaScript via webpack. | + | [xpath](./npm/xpath) | `@cypress/xpath` | Adds XPath command to Cypress.io test runner. | 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. From c81ba75f7fd34a4791285396cbf3e926b5c1a23b Mon Sep 17 00:00:00 2001 From: Emily Rohrbough Date: Wed, 21 Sep 2022 15:36:43 -0500 Subject: [PATCH 2/3] nit: new line --- CHANGELOG.md | 1 - 1 file changed, 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index dc9a3d3ec3e7..0fe28547aa15 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,3 @@ - # Changelogs - [Cypress App](https://on.cypress.io/changelog) From d0141cee248e670914ce39fa8ebb6c9ac8ffd2bc Mon Sep 17 00:00:00 2001 From: Emily Rohrbough Date: Thu, 22 Sep 2022 09:44:24 -0500 Subject: [PATCH 3/3] Update packages entries that are out of date. --- CONTRIBUTING.md | 17 ++++++++++++++--- packages/config/README.md | 2 +- packages/graphql/README.md | 2 +- 3 files changed, 16 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eb3acdc7b736..c27e74df8c62 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -259,22 +259,33 @@ Here is a list of the core packages in this repository with a short description, | Folder Name | Package Name | Purpose | | :------------------------------------ | :---------------------- | :--------------------------------------------------------------------------- | | [cli](./cli) | `cypress` | The command-line tool that is packaged as an `npm` module. | + | [app](./packages/app) | `@packages/app` | The the front-end for the Cypress App that renders in the launched browser instance. | + | [config](./packages/config) | `@packages/config` | The Cypress configuration types and validation used in the server, data-context and driver. | + | [data-context](./packages/data-context) | `@packages/data-context` | Centralized data access for the Cypress application. | | [driver](./packages/driver) | `@packages/driver` | The code that is used to drive the behavior of the API commands. | | [electron](./packages/electron) | `@packages/electron` | The Cypress implementation of Electron. | | [example](./packages/example) | `@packages/example` | Our example kitchen-sink application. | | [extension](./packages/extension) | `@packages/extension` | The Cypress Chrome browser extension | + | [frontend-shared](./packages/frontend-shared) | `@packages/frontend-shared` | Shared components and styles used in the `app` and `launchpad`. | + | [graphql](./packages/graphql) | `@packages/graphql` | The GraphQL layer that the `launchpad` and `app` use to interact with the `server`. | | [https-proxy](./packages/https-proxy) | `@packages/https-proxy` | This does https proxy for handling http certs and traffic. | + | [icons](./packages/icons) | `@packages/icons` | The Cypress icons. | + | [launcher](./packages/launcher) | `@packages/launcher` | Finds and launches browsers installed on your system. | + | [launchpad](./packages/launchpad) | `@packages/launcher` | The portal to running Cypress that displays in `open` mode. | | [net-stubbing](./packages/net-stubbing) | `@packages/net-stubbing` | Contains server side code for Cypress' network stubbing features. | | [network](./packages/network) | `@packages/network` | Various utilities related to networking. | | [proxy](./packages/proxy) | `@packages/proxy` | Code for Cypress' network proxy layer. | - | [launcher](./packages/launcher) | `@packages/launcher` | Finds and launches browsers installed on your system. | | [reporter](./packages/reporter) | `@packages/reporter` | The reporter shows the running results of the tests (The Command Log UI). | + | [resolve-dist](./packages/resolve-dist) | `@packages/resolve-dist` | Centralizes the resolution of paths to compiled/static assets from server-side code.. | + | [rewriter](./packages/rewriter) | `@packages/rewriter` | The logic to rewrite JS and HTML that flows through the Cypress proxy. | [root](./packages/root) | `@packages/root` | Dummy package pointing at the root of the repository. | - | [runner](./packages/runner) | `@packages/runner` | The runner is the minimal "chrome" around the user's application under test. | + | [runner](./packages/runner) | `@packages/runner` | (deprecated) The runner is the minimal "chrome" around the user's application under test. | + | [scaffold-config](./packages/scaffold-config) | `@packages/scaffold-config` | The logic related to scaffolding new projects using launchpad. | | [server](./packages/server) | `@packages/server` | The <3 of Cypress. This orchestrates everything. The backend node process. | - | [server-ct](./packages/server-ct) | `@packages/server-ct` | Some Component Testing specific overrides. Mostly extends functionality from `@packages/server` | | [socket](./packages/socket) | `@packages/socket` | A wrapper around socket.io to provide common libraries. | | [ts](./packages/ts) | `@packages/ts` | A centralized version of typescript. | + | [types](./packages/types) | `@packages/types` | The shared internal Cypress types. | + | [web-config](./packages/web-config) | `@packages/ui-components` | The web-related configuration. | 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. diff --git a/packages/config/README.md b/packages/config/README.md index 76a33c9c77ab..8e05385ad85d 100644 --- a/packages/config/README.md +++ b/packages/config/README.md @@ -1,6 +1,6 @@ # Config -The `config` package contains the configuration types and validation used in both the `server` and the `driver` for setting the Cypress configuration values. +The `config` package contains the configuration types and validation used in both the `server`, the `data-context` and the `driver` for setting the Cypress configuration values. ## Testing diff --git a/packages/graphql/README.md b/packages/graphql/README.md index 2b17a77708c8..70049f91087b 100644 --- a/packages/graphql/README.md +++ b/packages/graphql/README.md @@ -1,6 +1,6 @@ # GraphQL -The GraphQL layer that `@packages/launchpad` and `@packages/runner` use to interact with `@packages/server`. +The GraphQL layer that `@packages/launchpad` and `@packages/app` use to interact with `@packages/server`. With the goal of type safety, several tools and abstractions are used. The technologies are: