@jsenv/github-pull-request-impact 1.6.8 → 1.6.11

package/README.md

@@ -10,4 +10,4 @@ This repository publishes `@jsenv/github-pull-request-impact` on NPM. This packa
 
 - [@jsenv/performance-impact](../jsenv-performance-impact)
 - [@jsenv/file-size-impact](../jsenv-file-size-impact)
-- [@jsenv/lighthouse-score-impact](../jsenv-performance-impact)
+- [@jsenv/lighthouse-impact](../jsenv-lighthouse-impact)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/github-pull-request-impact",
-  "version": "1.6.8",
+  "version": "1.6.11",
   "description": "Report pull request impact on something",
   "license": "MIT",
   "author": {
@@ -34,24 +34,13 @@
   ],
   "scripts": {
     "eslint": "npx eslint . --ext=.js,.mjs",
-    "importmap": "node ./script/importmap/importmap.mjs",
     "test": "node ./script/test/test.mjs",
     "test-with-coverage": "npm run test -- --coverage",
     "prettier": "prettier --write ."
   },
   "dependencies": {
-    "@jsenv/filesystem": "2.7.1",
+    "@jsenv/filesystem": "3.1.0",
     "@jsenv/logger": "4.0.1",
     "node-fetch": "2.6.7"
-  },
-  "devDependencies": {
-    "@jsenv/assert": "2.4.1",
-    "@jsenv/core": "25.3.0",
-    "@jsenv/eslint-config": "16.0.9",
-    "@jsenv/importmap-eslint-resolver": "5.2.5",
-    "@jsenv/importmap-node-module": "5.1.3",
-    "eslint": "8.7.0",
-    "eslint-plugin-import": "2.25.4",
-    "prettier": "2.5.1"
   }
 }

package/src/commentGitHubPullRequestImpact.js

@@ -19,7 +19,7 @@ export const commentGitHubPullRequestImpact = async ({
   logLevel,
   commandLogs = false,
   infoLogs = true,
-  projectDirectoryUrl,
+  rootDirectoryUrl,
 
   githubToken,
   repositoryOwner,
@@ -33,7 +33,7 @@ export const commentGitHubPullRequestImpact = async ({
   createCommentForVersionMismatch = jsenvCreateCommentForVersionMismatch,
   createCommentForComparison = jsenvCreateCommentForComparison,
   generatedByLink = {
-    url: "https://github.com/jsenv/github-pull-request-impact",
+    url: "https://github.com/jsenv/workflow/tree/main/packages/jsenv-github-pull-request-impact",
     text: "@jsenv/github-pull-request-impact",
   },
   runLink,
@@ -41,7 +41,7 @@ export const commentGitHubPullRequestImpact = async ({
 
   catchError = false,
 }) => {
-  projectDirectoryUrl = assertAndNormalizeDirectoryUrl(projectDirectoryUrl)
+  rootDirectoryUrl = assertAndNormalizeDirectoryUrl(rootDirectoryUrl)
   if (typeof collectInfo !== "function") {
     throw new TypeError(
       `collectInfo must be a function but received ${collectInfo}`,
@@ -83,7 +83,7 @@ export const commentGitHubPullRequestImpact = async ({
       logger,
       commandLogs,
       infoLogs,
-      projectDirectoryUrl,
+      rootDirectoryUrl,
 
       githubToken,
       repositoryOwner,
@@ -111,7 +111,7 @@ const commentPrImpact = async ({
   logger,
   infoLogs,
   commandLogs,
-  projectDirectoryUrl,
+  rootDirectoryUrl,
 
   githubToken,
   repositoryOwner,
@@ -130,10 +130,10 @@ const commentPrImpact = async ({
 
   catchError,
 }) => {
-  const execCommandInProjectDirectory = (command) => {
+  const execCommandInRootDirectory = (command) => {
     logger.info(`> ${command}`)
     return exec(command, {
-      cwd: urlToFileSystemPath(projectDirectoryUrl),
+      cwd: urlToFileSystemPath(rootDirectoryUrl),
       onLog: (string) => {
         if (commandLogs) {
           logger.info(string)
@@ -177,7 +177,7 @@ const commentPrImpact = async ({
 
   logger.debug(`searching comment in pull request ${pullRequestHtmlUrl}`)
   const pullRequestCommentApiUrl = pullRequest.comments_url
-  const comments = await pullApiUrl.GET({
+  const comments = await githubRESTAPI.GET({
     url: pullRequestCommentApiUrl,
     githubToken,
   })
@@ -254,15 +254,15 @@ const commentPrImpact = async ({
   let beforeMergeInfo
   try {
     // cannot use depth=1 arg otherwise git merge might have merge conflicts
-    await execCommandInProjectDirectory(
+    await execCommandInRootDirectory(
       `git fetch --no-tags --prune origin ${pullRequestBase}`,
     )
-    await execCommandInProjectDirectory(
+    await execCommandInRootDirectory(
       `git reset --hard origin/${pullRequestBase}`,
     )
     beforeMergeInfo = await collectInfo({
       beforeMerge: true,
-      execCommandInProjectDirectory,
+      execCommandInRootDirectory,
     })
     if (infoLogs) {
       logger.debug(debugBeforeMergeInfo(beforeMergeInfo))
@@ -285,13 +285,13 @@ const commentPrImpact = async ({
   try {
     // buildCommand might generate files that could conflict when doing the merge
     // reset to avoid potential merge conflicts
-    await execCommandInProjectDirectory(
+    await execCommandInRootDirectory(
       `git reset --hard origin/${pullRequestBase}`,
     )
     // Avoid "The following untracked working tree files would be overwritten by merge" error
-    await execCommandInProjectDirectory(`git clean -d -f .`)
+    await execCommandInRootDirectory(`git clean -d -f .`)
     // cannot use depth=1 arg otherwise git merge might have merge conflicts
-    await execCommandInProjectDirectory(
+    await execCommandInRootDirectory(
       `git fetch --no-tags --prune origin ${headRef}`,
     )
     // ensure there is user.email + user.name required to perform git merge command
@@ -299,20 +299,25 @@ const commentPrImpact = async ({
 
     const restoreGitUserEmail = await ensureGitConfig("user.email", {
       valueIfMissing: "you@example.com",
-      execCommandInProjectDirectory,
+      execCommandInRootDirectory,
     })
     const restoreGitUserName = await ensureGitConfig("user.name", {
       valueIfMissing: "Your Name",
-      execCommandInProjectDirectory,
+      execCommandInRootDirectory,
     })
-    await execCommandInProjectDirectory(
-      `git merge FETCH_HEAD --allow-unrelated-histories`,
-    )
+    // could we use https://stackoverflow.com/a/6283843 ?
+    try {
+      await execCommandInRootDirectory(
+        `git merge FETCH_HEAD --allow-unrelated-histories --no-ff --no-commit`,
+      )
+    } catch (e) {
+      throw new Error(`git merge command failed (is there a merge conflict?)`)
+    }
     await restoreGitUserEmail()
     await restoreGitUserName()
     afterMergeInfo = await collectInfo({
       afterMerge: true,
-      execCommandInProjectDirectory,
+      execCommandInRootDirectory,
     })
     if (infoLogs) {
       logger.debug(debugAfterMergeInfo(afterMergeInfo))
@@ -359,17 +364,17 @@ const commentPrImpact = async ({
 
 const ensureGitConfig = async (
   name,
-  { execCommandInProjectDirectory, valueIfMissing },
+  { execCommandInRootDirectory, valueIfMissing },
 ) => {
   try {
-    await execCommandInProjectDirectory(`git config ${name}`)
+    await execCommandInRootDirectory(`git config ${name}`)
     return () => {}
   } catch (e) {
-    await execCommandInProjectDirectory(
+    await execCommandInRootDirectory(
       `git config ${name} "${valueIfMissing}"`,
     )
     return async () => {
-      await execCommandInProjectDirectory(`git config --unset ${name}`)
+      await execCommandInRootDirectory(`git config --unset ${name}`)
     }
   }
 }

package/src/internal/exec.js

@@ -11,11 +11,11 @@ export const exec = (
         cwd,
         stdio: "silent",
       },
-      (error) => {
+      (error, out) => {
         if (error) {
           reject(error)
         } else {
-          resolve()
+          resolve(out)
         }
       },
     )

package/src/readGitHubWorkflowEnv.js

@@ -28,7 +28,7 @@ export const readGitHubWorkflowEnv = () => {
       }
     : undefined
   return {
-    projectDirectoryUrl: process.env.GITHUB_WORKSPACE,
+    rootDirectoryUrl: process.env.GITHUB_WORKSPACE,
     githubToken,
     repositoryOwner,
     repositoryName,