chore: enforce changelog entries on PR reviews (#25459)

Co-authored-by: Blue F <blue@cypress.io>

Author: emilyrohrbough

.circleci/workflows.yml

@@ -41,6 +41,7 @@ macWorkflowFilters: &darwin-workflow-filters
     - matches:
         pattern: /^release\/\d+\.\d+\.\d+$/
         value: << pipeline.git.branch >>
+
 linuxArm64WorkflowFilters: &linux-arm64-workflow-filters
   when:
     or:
@@ -1431,14 +1432,17 @@ jobs:
           path: packages/errors/__snapshot-images__
       - store-npm-logs
 
-  unit-tests-release:
+  verify-release-readiness:
     <<: *defaults
     resource_class: small
     parallelism: 1
+    environment:
+      GITHUB_TOKEN: $GH_TOKEN
     steps:
       - restore_cached_workspace
       - update_known_hosts
       - run: yarn test-npm-package-release-script
+      - run: node ./scripts/semantic-commits/validate-binary-changelog.js
 
   lint-types:
     <<: *defaults
@@ -2373,7 +2377,7 @@ linux-x64-workflow: &linux-x64-workflow
     - unit-tests:
         requires:
           - build
-    - unit-tests-release:
+    - verify-release-readiness:
         context: test-runner:npm-release
         requires:
           - build
@@ -2547,7 +2551,7 @@ linux-x64-workflow: &linux-x64-workflow
           - server-unit-tests
           - test-kitchensink
           - unit-tests
-          - unit-tests-release
+          - verify-release-readiness
           - cli-visual-tests
           - reporter-integration-tests
           - run-app-component-tests-chrome

.github/PULL_REQUEST_TEMPLATE.md

@@ -7,12 +7,6 @@
 
 - Closes <!-- link to the issue here, if there is one -->
 
-### User facing changelog
-<!-- 
-Explain the change(s) for every user to read in our changelog. Examples: https://on.cypress.io/changelog
-If the change is not user-facing, write "n/a".
--->
-
 ### Additional details
 <!-- Examples:
 - Why was this change necessary?

.github/workflows/semantic-pull-request.yml

@@ -9,13 +9,21 @@ on:
 
 jobs:
   main:
-    name: Lint Title
+    name: Semantic Pull Request
     runs-on: ubuntu-latest
     steps:
-      # use a fork of the GitHub action - we cannot pull in untrusted third party actions
-      # see https://github.com/cypress-io/cypress/pull/20091#discussion_r801799647
-      - uses: cypress-io/action-semantic-pull-request@v4
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Checkout
+        uses: actions/checkout@v3
         with:
-          validateSingleCommit: true
+          ref: ${{ github.event.pull_request.head.ref }}
+          repository: ${{ github.event.pull_request.head.repo.full_name }}
+      - run: npm install
+        working-directory: scripts/github-actions/semantic-pull-request/
+      - name: Lint PR Title and Cypress Changelog Entry
+        if: github.event_name == 'pull_request_target'
+        uses: actions/github-script@v4
+        with:
+          script: |
+            const verifyPullRequest = require('./scripts/github-actions/semantic-pull-request')
+
+            await verifyPullRequest({ context, core, github })

.releaserc.base.js

@@ -1,3 +1,31 @@
+const { parserOpts, releaseRules } = require('./scripts/semantic-commits/change-categories')
+
 module.exports = {
-  ...require('./.releaserc.base'),
+  plugins: [
+    ['@semantic-release/commit-analyzer', {
+      preset: 'angular',
+      parserOpts,
+      releaseRules,
+    }],
+    ['@semantic-release/release-notes-generator',
+      {
+        preset: 'angular',
+        parserOpts,
+      }
+    ],
+    ['@semantic-release/changelog', {
+      changelogFile: 'CHANGELOG.md',
+    }],
+    ['@semantic-release/git', {
+      assets: [
+        './CHANGELOG.md',
+      ],
+      message: 'chore: release ${nextRelease.gitTag}\n\n[skip ci]',
+    }],
+    '@semantic-release/npm',
+  ],
+  extends: 'semantic-release-monorepo',
+  branches: [
+    { name: 'develop', channel: 'latest' },
+  ],
 }

.releaserc.js

@@ -459,7 +459,22 @@ We do not continuously deploy the Cypress binary, so `develop` contains all of t
 - Break down pull requests into the smallest necessary parts to address the original issue or feature. This helps you get a timely review and helps the reviewer clearly understand which pieces of the code changes are relevant.
 - When opening a PR for a specific issue already open, please name the branch you are working on using the convention `issue-[issue number]`. For example, if your PR fixes Issue #803, name your branch `issue-803`. If the PR is a larger issue, you can add more context like `issue-803-new-scrollable-area`. If there's not an associated open issue, **[create an issue](https://github.com/cypress-io/cypress/issues/new/choose)**.
 - PRs can be opened before all the work is finished. In fact we encourage this! Please create a [Draft Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests) if your PR is not ready for review. [Mark the PR as **Ready for Review**](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/changing-the-stage-of-a-pull-request#marking-a-pull-request-as-ready-for-review) when you're ready for a Cypress team member to review the PR.
-- Prefix the title of the Pull Request using [semantic-release](https://github.com/semantic-release/semantic-release)'s format as defined [here](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#type). For example, if your PR is fixing a bug, you should prefix the PR title with `fix:`.
+- Prefix the title of the Pull Request using [semantic-release](https://github.com/semantic-release/semantic-release)'s format using one of the following definitions. Once committed to develop, this prefix will determine the appropriate 'next version' of Cypress or the corresponding npm module.
+  - Changes has user-facing impact:
+    - `breaking` - A breaking change that will require a MVB
+    - `dependency` - A change to a dependency that impact the user
+    - `deprecation` - A API deprecation notice for users
+    - `feat` - A new feature
+    - `fix` - A bug fix or regression fix.
+    - `misc` - a misc user-facing change, like a UI update which is not a fix or enhancement to how Cypress works
+    - `perf` - A code change that improves performance
+  - Changes that improves the codebase or system but has no user-facing impact:
+    - `chore` - Changes to the build process or auxiliary tools and libraries such as documentation generation
+    - `docs` -  Documentation only changes
+    - `refactor` - A code change that neither fixes a bug nor adds a feature
+    - `revert` - Reverts a previous commit
+    - `test` - Adding missing or correcting existing tests
+- For user-facing changes that will be released with the next Cypress version, be sure to add a changelog entry to the appropriate section in [`cli/CHANGELOG.md`](./cli/CHANGELOG.md). See [Writing the Cypress Changelog Guide](./guides/writing-the-cypress-changelog.md) for more details.
 - Fill out the [Pull Request Template](./.github/PULL_REQUEST_TEMPLATE.md) completely within the body of the PR. If you feel some areas are not relevant add `N/A` as opposed to deleting those sections. PRs will not be reviewed if this template is not filled in.
 - If the PR is a user facing change and you're a Cypress team member that has logged into [ZenHub](https://www.zenhub.com/) and downloaded the [ZenHub for GitHub extension](https://www.zenhub.com/extension), set the release the PR is intended to ship in from the sidebar of the PR. Follow semantic versioning to select the intended release. This is used to generate the changelog for the release. If you don't tag a PR for release, it won't be mentioned in the changelog.
   ![Select release for PR](https://user-images.githubusercontent.com/1271364/135139641-657015d6-2dca-42d4-a4fb-16478f61d63f.png)

CONTRIBUTING.md

@@ -0,0 +1,68 @@
+ <!-- See the ../guides/writing-the-cypress-changelog.md for details on writing the changelog. -->
+## 12.4.1
+
+_Released 01/31/2023 (PENDING)_
+
+## 12.4.0
+
+_Released 1/24/2023_
+
+**Features:**
+
+- Added official support for Vite 4 in component testing. Addresses
+  [#24969](https://github.com/cypress-io/cypress/issues/24969).
+- Added new
+  [`experimentalMemoryManagement`](/guides/references/experiments#Configuration)
+  configuration option to improve memory management in Chromium-based browsers.
+  Enable this option with `experimentalMemoryManagement=true` if you have
+  experienced "Out of Memory" issues. Addresses
+  [#23391](https://github.com/cypress-io/cypress/issues/23391).
+- Added new
+  [`experimentalSkipDomainInjection`](/guides/references/experiments#Experimental-Skip-Domain-Injection)
+  configuration option to disable Cypress from setting `document.domain` on
+  injection, allowing users to test Salesforce domains. If you believe you are
+  having `document.domain` issues, please see the
+  [`experimentalSkipDomainInjection`](/guides/references/experiments#Experimental-Skip-Domain-Injection)
+  guide. This config option is end-to-end only. Addresses
+  [#2367](https://github.com/cypress-io/cypress/issues/2367),
+  [#23958](https://github.com/cypress-io/cypress/issues/23958),
+  [#24290](https://github.com/cypress-io/cypress/issues/24290), and
+  [#24418](https://github.com/cypress-io/cypress/issues/24418).
+- The [`.as`](/api/commands/as) command now accepts an options argument,
+  allowing an alias to be stored as type "query" or "static" value. This is
+  stored as "query" by default. Addresses
+  [#25173](https://github.com/cypress-io/cypress/issues/25173).
+- The `cy.log()` command will now display a line break where the `\n` character
+  is used. Addresses
+  [#24964](https://github.com/cypress-io/cypress/issues/24964).
+- [`component.specPattern`](/guides/references/configuration#component) now
+  utilizes a JSX/TSX file extension when generating a new empty spec file if
+  project contains at least one file with those extensions. This applies only to
+  component testing and is skipped if
+  [`component.specPattern`](/guides/references/configuration#component) has been
+  configured to exclude files with those extensions. Addresses
+  [#24495](https://github.com/cypress-io/cypress/issues/24495).
+- Added support for the `data-qa` selector in the
+  [Selector Playground](guides/core-concepts/cypress-app#Selector-Playground) in
+  addition to `data-cy`, `data-test` and `data-testid`. Addresses
+  [#25305](https://github.com/cypress-io/cypress/issues/25305).
+
+**Bugfixes:**
+
+- Fixed an issue where component tests could incorrectly treat new major
+  versions of certain dependencies as supported. Fixes
+  [#25379](https://github.com/cypress-io/cypress/issues/25379).
+- Fixed an issue where new lines or spaces on new lines in the Command Log were
+  not maintained. Fixes
+  [#23679](https://github.com/cypress-io/cypress/issues/23679) and
+  [#24964](https://github.com/cypress-io/cypress/issues/24964).
+- Fixed an issue where Angular component testing projects would fail to
+  initialize if an unsupported browserslist entry was specified in the project
+  configuration. Fixes
+  [#25312](https://github.com/cypress-io/cypress/issues/25312).
+
+**Misc**
+
+- Video output link in `cypress run` mode has been added to it's own line to
+  make the video output link more easily clickable in the terminal. Addresses
+  [#23913](https://github.com/cypress-io/cypress/issues/23913).

cli/CHANGELOG.md

@@ -17,8 +17,10 @@ For general contributor information, check out [`CONTRIBUTING.md`](../CONTRIBUTI
 * [Determining the next version of Cypress to be released](./next-version.md)
 * [E2E Open Mode Testing](./e2e-open-testing.md)
 * [Error handling](./error-handling.md)
+* [GraphQL Subscriptions - Overview and Test Guide](./graphql-subscriptions.md)
 * [Patching packages](./patch-package.md)
 * [Release process](./release-process.md)
 * [Testing other projects](./testing-other-projects.md)
 * [Testing strategy and style guide (draft)](./testing-strategy-and-styleguide.md)
 * [Writing cross-platform JavaScript](./writing-cross-platform-javascript.md)
+* [Writing the Cypress Changelog](./writing-the-cypress-changelog.md)