feat: working-directory with only-new-issues (#795)

Co-authored-by: Fernandez Ludovic <ldez@users.noreply.github.com>

.gitattributes

@@ -0,0 +1 @@
+dist/** linguist-generated=true

.github/release.yml

@@ -0,0 +1,15 @@
+changelog:
+  categories:
+    - title: Changes
+      labels:
+        - '*'
+      exclude:
+        labels:
+          - documentation
+          - dependencies
+    - title: Documentation
+      labels:
+        - documentation
+    - title: Dependencies
+      labels:
+        - dependencies

README.md

@@ -46,32 +46,34 @@ jobs:
       - name: golangci-lint
         uses: golangci/golangci-lint-action@v3
         with:
-          # Require: version of golangci-lint to use in form of v1.2 or v1.2.3 or `latest` to use the latest version
+          # Require: The version of golangci-lint to use.
+          # When `install-mode` is `binary` (default) the value can be v1.2 or v1.2.3 or `latest` to use the latest version.
+          # When `install-mode` is `goinstall` the value can be v1.2.3, `latest`, or the hash of a commit.
           version: v1.53
 
           # Optional: working directory, useful for monorepos
           # working-directory: somedir
 
           # Optional: golangci-lint command line arguments.
-          # 
+          #
-          # Note: by default the `.golangci.yml` file should be at the root of the repository.
+          # Note: By default, the `.golangci.yml` file should be at the root of the repository.
           # The location of the configuration file can be changed by using `--config=`
           # args: --timeout=30m --config=/my/path/.golangci.yml --issues-exit-code=0 
 
           # Optional: show only new issues if it's a pull request. The default value is `false`.
           # only-new-issues: true
 
-          # Optional: if set to true then the all caching functionality will be complete disabled,
+          # Optional: if set to true, then all caching functionality will be completely disabled,
           #           takes precedence over all other caching options.
           # skip-cache: true
 
-          # Optional: if set to true then the action don't cache or restore ~/go/pkg.
+          # Optional: if set to true, then the action won't cache or restore ~/go/pkg.
           # skip-pkg-cache: true
 
-          # Optional: if set to true then the action don't cache or restore ~/.cache/go-build.
+          # Optional: if set to true, then the action won't cache or restore ~/.cache/go-build.
           # skip-build-cache: true
-          
+
-          # Optional:The mode to install golangci-lint. It can be 'binary' or 'goinstall'.
+          # Optional: The mode to install golangci-lint. It can be 'binary' or 'goinstall'.
           # install-mode: "goinstall"
 ```
 
@@ -113,7 +115,9 @@ jobs:
       - name: golangci-lint
         uses: golangci/golangci-lint-action@v3
         with:
-          # Require: version of golangci-lint to use in form of v1.2 or v1.2.3 or `latest` to use the latest version
+          # Require: The version of golangci-lint to use.
+          # When `install-mode` is `binary` (default) the value can be v1.2 or v1.2.3 or `latest` to use the latest version.
+          # When `install-mode` is `goinstall` the value can be v1.2.3, `latest`, or the hash of a commit.
           version: v1.53
 
           # Optional: working directory, useful for monorepos

action.yml

@@ -3,7 +3,10 @@ description: "Official golangci-lint action with line-attached annotations for f
 author: "golangci"
 inputs:
   version:
-    description: "version of golangci-lint to use in form of v1.2 or v1.2.3 or `latest` to use the latest version"
+    description: |
+      The version of golangci-lint to use.
+      When `install-mode` is `binary` (default) the value can be v1.2 or v1.2.3 or `latest` to use the latest version.
+      When `install-mode` is `goinstall` the value can be v1.2.3, `latest`, or the hash of a commit.
     required: false
   args:
     description: "golangci-lint command line arguments"
@@ -18,21 +21,21 @@ inputs:
     required: false
   only-new-issues:
     description: "if set to true and the action runs on a pull request - the action outputs only newly found issues"
-    default: false
+    default: 'false'
     required: false
   skip-cache:
     description: |
       if set to true then the all caching functionality will be complete disabled,
       takes precedence over all other caching options.
-    default: false
+    default: 'false'
     required: false
   skip-pkg-cache:
     description: "if set to true then the action doesn't cache or restore ~/go/pkg."
-    default: false
+    default: 'false'
     required: false
   skip-build-cache:
     description: "if set to true then the action doesn't cache or restore ~/.cache/go-build."
-    default: false
+    default: 'false'
     required: false
   install-mode:
     description: "The mode to install golangci-lint. It can be 'binary' or 'goinstall'."

package.json

@@ -24,27 +24,27 @@
   "author": "golangci",
   "license": "MIT",
   "dependencies": {
-    "@actions/cache": "^3.2.1",
+    "@actions/cache": "^3.2.2",
     "@actions/core": "^1.10.0",
     "@actions/exec": "^1.1.1",
     "@actions/github": "^5.1.1",
-    "@actions/http-client": "^2.1.0",
+    "@actions/http-client": "^2.1.1",
     "@actions/tool-cache": "^2.0.1",
-    "@types/node": "^20.2.5",
+    "@types/node": "^20.5.0",
     "@types/semver": "^7.5.0",
     "@types/tmp": "^0.2.3",
     "tmp": "^0.2.1"
   },
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^5.59.8",
+    "@typescript-eslint/eslint-plugin": "^6.3.0",
-    "@typescript-eslint/parser": "^5.59.8",
+    "@typescript-eslint/parser": "^6.3.0",
     "@vercel/ncc": "^0.36.1",
-    "eslint": "^8.42.0",
+    "eslint": "^8.47.0",
-    "eslint-config-prettier": "^8.8.0",
+    "eslint-config-prettier": "^9.0.0",
-    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-import": "^2.28.0",
-    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-prettier": "^5.0.0",
     "eslint-plugin-simple-import-sort": "^10.0.0",
-    "prettier": "^2.8.8",
+    "prettier": "^3.0.1",
-    "typescript": "^5.1.3"
+    "typescript": "^5.1.6"
   }
 }

src/run.ts

@@ -8,6 +8,7 @@ import { promisify } from "util"
 
 import { restoreCache, saveCache } from "./cache"
 import { installLint, InstallMode } from "./install"
+import { alterDiffPatch } from "./utils/diffUtils"
 import { findLintVersion } from "./version"
 
 const execShellCommand = promisify(exec)
@@ -68,7 +69,7 @@ async function fetchPatch(): Promise<string> {
     const tempDir = await createTempDir()
     const patchPath = path.join(tempDir, "pull.patch")
     core.info(`Writing patch to ${patchPath}`)
-    await writeFile(patchPath, patch)
+    await writeFile(patchPath, alterDiffPatch(patch))
     return patchPath
   } catch (err) {
     console.warn(`failed to save pull request patch:`, err)
@@ -157,10 +158,6 @@ async function runLint(lintPath: string, patchPath: string): Promise<void> {
   const workingDirectory = core.getInput(`working-directory`)
   const cmdArgs: ExecOptions = {}
   if (workingDirectory) {
-    if (patchPath) {
-      // TODO: make them compatible
-      throw new Error(`options working-directory and only-new-issues aren't compatible`)
-    }
     if (!fs.existsSync(workingDirectory) || !fs.lstatSync(workingDirectory).isDirectory()) {
       throw new Error(`working-directory (${workingDirectory}) was not a path`)
     }

src/utils/diffUtils.ts

@@ -0,0 +1,56 @@
+import * as core from "@actions/core"
+import * as path from "path"
+
+// If needed alter diff file to be compatible with working directory
+export function alterDiffPatch(patch: string): string {
+  const workingDirectory = core.getInput(`working-directory`)
+
+  if (workingDirectory) {
+    return alterPatchWithWorkingDirectory(patch, workingDirectory)
+  }
+
+  return patch
+}
+
+function alterPatchWithWorkingDirectory(patch: string, workingDirectory: string): string {
+  const workspace = process.env["GITHUB_WORKSPACE"] || ""
+
+  const wd = path.relative(workspace, workingDirectory)
+
+  // ignore diff sections not related to the working directory
+  let ignore = false
+
+  const lines = patch.split("\n")
+  const filteredLines = []
+
+  // starts with "--- a/xxx/" or "+++ a/xxx/" or "--- b/xxx/" or "+++ b/xxx/"
+  const cleanDiff = new RegExp(`^((?:\\+{3}|-{3}) [ab]\\/)${escapeRegExp(wd)}\\/(.*)`, "gm")
+
+  // contains " a/xxx/" or " b/xxx/"
+  const firstLine = new RegExp(`( [ab]\\/)${escapeRegExp(wd)}\\/(.*)`, "gm")
+
+  for (const line of lines) {
+    if (line.startsWith("diff --git")) {
+      ignore = !line.includes(` a/${wd}/`)
+      if (ignore) {
+        continue
+      }
+
+      filteredLines.push(line.replaceAll(firstLine, "$1$2"))
+    } else {
+      if (ignore) {
+        continue
+      }
+
+      filteredLines.push(line.replaceAll(cleanDiff, "$1$2"))
+    }
+  }
+
+  // Join the modified lines back into a diff string
+  return filteredLines.join("\n")
+}
+
+// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
+function escapeRegExp(exp: string): string {
+  return exp.replace(/[.*+?^${}()|[\]\\]/g, "\\$&") // $& means the whole matched string
+}

tsconfig.json

@@ -1,6 +1,6 @@
 {
   "compilerOptions": {
-    "target": "es6",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
+    "target": "ES2021",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
     "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
     "outDir": "./lib",                        /* Redirect output structure to the directory. */
     "rootDir": "./src",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */