chore: update validate changelog to pull target branch (#32561)

Author: mschile

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

@@ -34,8 +34,8 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
         with:
-          ref: ${{ github.event.pull_request.head.ref }}
-          repository: ${{ github.event.pull_request.head.repo.full_name }}
+          ref: ${{ github.event.pull_request.base.ref }}
+          repository: ${{ github.event.pull_request.base.repo.full_name }}
       - run: npm install
         working-directory: scripts/github-actions/semantic-pull-request/
       - name: Lint PR Title and Cypress Changelog Entry

scripts/github-actions/semantic-pull-request/index.js

@@ -45,7 +45,22 @@ async function run ({ context, core, github }) {
 
     const changedFiles = data.map((fileDetails) => fileDetails.filename)
 
+    // retrieve the changelog content from the pull request
+    let changelogContent = null
+
+    if (changedFiles.includes('cli/CHANGELOG.md')) {
+      const { data: changelogData } = await github.rest.repos.getContent({
+        owner: contextPullRequest.head.user.login,
+        repo: contextPullRequest.head.repo.name,
+        path: 'cli/CHANGELOG.md',
+        ref: contextPullRequest.head.sha,
+      })
+
+      changelogContent = Buffer.from(changelogData.content, 'base64').toString('utf8')
+    }
+
     await validateChangelog({
+      changelogContent,
       changedFiles,
       commits: [{
         commitMessage: header,

scripts/semantic-commits/parse-changelog.js

@@ -3,8 +3,8 @@ const path = require('path')
 const { userFacingChanges } = require('./change-categories')
 const userFacingSections = Object.values(userFacingChanges).map(({ section }) => section)
 
-async function parseChangelog (pendingRelease = true) {
-  const changelog = fs.readFileSync(path.join(__dirname, '..', '..', 'cli', 'CHANGELOG.md'), 'utf8')
+async function parseChangelog ({ pendingRelease = true, changelogContent = null } = {}) {
+  const changelog = changelogContent || fs.readFileSync(path.join(__dirname, '..', '..', 'cli', 'CHANGELOG.md'), 'utf8')
   const changeLogLines = changelog.split('\n')
 
   let parseChangelog = true

scripts/semantic-commits/validate-changelog.js

@@ -129,7 +129,7 @@ const _handleErrors = (errors) => {
  * environment variable in CircleCI to a branch or comma-separated list of
  * branches
  */
-async function validateChangelog ({ changedFiles, nextVersion, pendingRelease, commits }) {
+async function validateChangelog ({ changedFiles, nextVersion, pendingRelease, commits, changelogContent }) {
   if (process.env.SKIP_RELEASE_CHANGELOG_VALIDATION_FOR_BRANCHES) {
     const branches = process.env.SKIP_RELEASE_CHANGELOG_VALIDATION_FOR_BRANCHES.split(',')
 
@@ -171,7 +171,7 @@ async function validateChangelog ({ changedFiles, nextVersion, pendingRelease, c
     }
   }
 
-  const changelog = await parseChangelog(pendingRelease)
+  const changelog = await parseChangelog({ pendingRelease, changelogContent })
 
   if (nextVersion && !changelog.version === `## ${nextVersion}`) {
     errors.push(`The changelog version does not contain the next Cypress version of ${nextVersion}. If the changelog version is correct, please correct the pull request title to correctly reflect the change being made.`)

scripts/unit/semantic-commits/validate-changelog-spec.js

@@ -160,6 +160,33 @@ _Released 01/17/2033 (PENDING)_
       expect(console.log).to.be.calledWith('It appears at a high-level your changelog entry is correct! The remaining validation is left to the pull request reviewers.')
     })
 
+    it('verifies changelog entry has been included when the changelog is passed in', async () => {
+      const changedFiles = [
+        'packages/driver/lib/index.js',
+        'cli/CHANGELOG.md',
+      ]
+
+      const changelogContent = `
+## 120.2.0
+
+_Released 01/17/2033 (PENDING)_
+
+**Performance:**
+
+- Fixed in [#77](https://github.com/cypress-io/cypress/pull/77).`
+
+      await validateChangelog({
+        changelogContent,
+        changedFiles,
+        commits: [{
+          prNumber: 77,
+          semanticType: 'perf',
+        }],
+      })
+
+      expect(console.log).to.be.calledWith('It appears at a high-level your changelog entry is correct! The remaining validation is left to the pull request reviewers.')
+    })
+
     it('verifies changelog with shared entry', async () => {
       const changedFiles = [
         'packages/driver/lib/index.js',