feat: improve log about pwd/cwd (#1033)

README.md

@@ -100,7 +100,12 @@ You will also likely need to add the following `.gitattributes` file to ensure t
 
 ## Options
 
-`version`: (required) The version of golangci-lint to use.
+### `version`
+
+(required)
+
+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.
 
@@ -111,8 +116,12 @@ with:
   # ...
 ```
 
-`install-mode`: (optional) The mode to install golangci-lint.
+### `install-mode`
-It can be `binary` or `goinstall`.
+
+(optional)
+
+The mode to install golangci-lint: it can be `binary` or `goinstall`.
+
 The default value is `binary`.
 
 ```yml
@@ -122,8 +131,12 @@ with:
   # ...
 ```
 
-`only-new-issues`: (optional) Show only new issues.
+### `only-new-issues`
-If you are using `merge_group` event (merge queue) you should add the option `fetch-depth: 0` to `actions/checkout` step.
+
+(optional)
+
+Show only new issues.
+
 The default value is `false`.
 
 ```yml
@@ -133,7 +146,16 @@ with:
   # ...
 ```
 
-`working-directory`: (optional) working directory, useful for monorepos.
+* `pull_request` and `pull_request_target`: the action gets the diff of the PR content from the [GitHub API](https://docs.github.com/en/rest/pulls/pulls?apiVersion=2022-11-28#get-a-pull-request) and use it with `--new-from-patch`.
+* `push`: the action gets the diff of the push content (difference between commits before and after the push) from the [GitHub API](https://docs.github.com/en/rest/commits/commits?apiVersion=2022-11-28#compare-two-commits) and use it with `--new-from-patch`.
+* `merge_group`: the action gets the diff by using `--new-from-rev` option (relies on git).
+   You should add the option `fetch-depth: 0` to `actions/checkout` step.
+
+### `working-directory`
+
+(optional)
+
+Working directory, useful for monorepos.
 
 ```yml
 uses: golangci/golangci-lint-action@v5
@@ -142,8 +164,13 @@ with:
   # ...
 ```
 
-`skip-cache`: (optional) If set to `true`, then all caching functionality will be completely disabled,
+### `skip-cache`
+
+(optional)
+
+If set to `true`, then all caching functionality will be completely disabled,
 takes precedence over all other caching options.
+
 The default value is `false`.
 
 ```yml
@@ -153,7 +180,12 @@ with:
   # ...
 ```
 
-`skip-save-cache`: (optional) If set to `true`, caches will not be saved, but they may still be restored, required `skip-cache: false`.
+### `skip-save-cache`
+
+(optional)
+
+If set to `true`, caches will not be saved, but they may still be restored, required `skip-cache: false`.
+
 The default value is `false`.
 
 ```yml
@@ -163,9 +195,34 @@ with:
   # ...
 ```
 
-`annotations`: (optional) To enable/disable GitHub Action annotations.
+### `cache-invalidation-interval`
-If disabled (`false`), the output format(s) will follow the golangci-lint configuration file and use the same default as golangci-lint (i.e. `colored-line-number`).
+
+(optional)
+
+Periodically invalidate the cache every `cache-invalidation-interval` days to ensure that outdated data is removed and fresh data is loaded.
+
+The default value is `7`.
+
+```yml
+uses: golangci/golangci-lint-action@v5
+with:
+  cache-invalidation-interval: 15
+  # ...
+```
+
+If set the number is `<= 0`, the cache will be always invalidate (Not recommended).
+
+### `annotations`
+
+(optional)
+
+To enable/disable GitHub Action annotations.
+
+If disabled (`false`), the output format(s) will follow the golangci-lint configuration file (or CLI flags from `args`) 
+and use the same default as golangci-lint (i.e. `colored-line-number`).
+
 https://golangci-lint.run/usage/configuration/#output-configuration
+
 The default value is `true`.
 
 ```yml
@@ -175,7 +232,12 @@ with:
   # ...
 ```
 
-`args`: (optional) golangci-lint command line arguments.
+### `args`
+
+(optional)
+
+golangci-lint command line arguments.
+
 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=`
 
@@ -246,10 +308,11 @@ Inside our action, we perform 3 steps:
 ### Caching internals
 
 1. We save and restore the following directory: `~/.cache/golangci-lint`.
-2. The primary caching key looks like `golangci-lint.cache-{interval_number}-{go.mod_hash}`.
+2. The primary caching key looks like `golangci-lint.cache-{runner_os}-{working_directory}-{interval_number}-{go.mod_hash}`.
    Interval number ensures that we periodically invalidate our cache (every 7 days).
    `go.mod` hash ensures that we invalidate the cache early - as soon as dependencies have changed.
-3. We use [restore keys](https://help.github.com/en/actions/configuring-and-managing-workflows/caching-dependencies-to-speed-up-workflows#matching-a-cache-key): `golangci-lint.cache-{interval_number}-`. 
+3. We use [restore keys](https://help.github.com/en/actions/configuring-and-managing-workflows/caching-dependencies-to-speed-up-workflows#matching-a-cache-key):
+   `golangci-lint.cache-{runner_os}-{working_directory}-{interval_number}-`.
    GitHub matches keys by prefix if we have no exact match for the primary cache.
 
 This scheme is basic and needs improvements. Pull requests and ideas are welcome.

action.yml

@@ -44,6 +44,10 @@ inputs:
     description: "golangci-lint command line arguments"
     default: ""
     required: false
+  cache-invalidation-interval:
+    description: "Periodically invalidate a cache because a new code being added. (number of days)"
+    default: '7'
+    required: false
 runs:
   using: "node20"
   main: "dist/run/index.js"

dist/post_run/index.js

@@ -88815,18 +88815,26 @@ const getLintCacheDir = () => {
 };
 const getIntervalKey = (invalidationIntervalDays) => {
     const now = new Date();
+    if (invalidationIntervalDays <= 0) {
+        return `${now.getTime()}`;
+    }
     const secondsSinceEpoch = now.getTime() / 1000;
     const intervalNumber = Math.floor(secondsSinceEpoch / (invalidationIntervalDays * 86400));
     return intervalNumber.toString();
 };
 async function buildCacheKeys() {
     const keys = [];
-    // Periodically invalidate a cache because a new code being added.
+    // Cache by OS.
-    // TODO: configure it via inputs.
+    let cacheKey = `golangci-lint.cache-${process.env?.RUNNER_OS}-`;
-    let cacheKey = `golangci-lint.cache-${getIntervalKey(7)}-`;
-    keys.push(cacheKey);
     // Get working directory from input
     const workingDirectory = core.getInput(`working-directory`);
+    if (workingDirectory) {
+        cacheKey += `${workingDirectory}-`;
+    }
+    // Periodically invalidate a cache because a new code being added.
+    const invalidationIntervalDays = parseInt(core.getInput(`cache-invalidation-interval`, { required: true }).trim());
+    cacheKey += `${getIntervalKey(invalidationIntervalDays)}-`;
+    keys.push(cacheKey);
     // create path to go.mod prepending the workingDirectory if it exists
     const goModPath = path_1.default.join(workingDirectory, `go.mod`);
     core.info(`Checking for go.mod: ${goModPath}`);
@@ -88841,7 +88849,7 @@ async function buildCacheKeys() {
     return keys;
 }
 async function restoreCache() {
-    if (core.getInput(`skip-cache`, { required: true }).trim() == "true")
+    if (core.getBooleanInput(`skip-cache`, { required: true }))
         return;
     if (!utils.isValidEvent()) {
         utils.logWarning(`Event Validation Error: The event type ${process.env[constants_1.Events.Key]} is not supported because it's not tied to a branch or tag ref.`);
@@ -88879,9 +88887,9 @@ async function restoreCache() {
 }
 exports.restoreCache = restoreCache;
 async function saveCache() {
-    if (core.getInput(`skip-cache`, { required: true }).trim() == "true")
+    if (core.getBooleanInput(`skip-cache`, { required: true }))
         return;
-    if (core.getInput(`skip-save-cache`, { required: true }).trim() == "true")
+    if (core.getBooleanInput(`skip-save-cache`, { required: true }))
         return;
     // Validate inputs, this can cause task failure
     if (!utils.isValidEvent()) {
@@ -89147,11 +89155,7 @@ const execShellCommand = (0, util_1.promisify)(child_process_1.exec);
 const writeFile = (0, util_1.promisify)(fs.writeFile);
 const createTempDir = (0, util_1.promisify)(tmp_1.dir);
 function isOnlyNewIssues() {
-    const onlyNewIssues = core.getInput(`only-new-issues`, { required: true }).trim();
+    return core.getBooleanInput(`only-new-issues`, { required: true });
-    if (onlyNewIssues !== `false` && onlyNewIssues !== `true`) {
-        throw new Error(`invalid value of "only-new-issues": "${onlyNewIssues}", expected "true" or "false"`);
-    }
-    return onlyNewIssues === `true`;
 }
 async function prepareLint() {
     const mode = core.getInput("install-mode").toLowerCase();
@@ -89221,11 +89225,10 @@ async function fetchPushPatch(ctx) {
     const octokit = github.getOctokit(core.getInput(`github-token`, { required: true }));
     let patch;
     try {
-        const patchResp = await octokit.rest.repos.compareCommits({
+        const patchResp = await octokit.rest.repos.compareCommitsWithBasehead({
             owner: ctx.repo.owner,
             repo: ctx.repo.repo,
-            base: ctx.payload.before,
+            basehead: `${ctx.payload.before}..${ctx.payload.after}`,
-            head: ctx.payload.after,
             mediaType: {
                 format: `diff`,
             },
@@ -89287,7 +89290,7 @@ async function runLint(lintPath, patchPath) {
         .map(([key, value]) => [key.toLowerCase(), value ?? ""]);
     const userArgsMap = new Map(userArgsList);
     const userArgNames = new Set(userArgsList.map(([key]) => key));
-    const annotations = core.getInput(`annotations`).trim() !== "false";
+    const annotations = core.getBooleanInput(`annotations`);
     if (annotations) {
         const formats = (userArgsMap.get("out-format") || "")
             .trim()
@@ -89326,8 +89329,8 @@ async function runLint(lintPath, patchPath) {
                 break;
         }
     }
-    const workingDirectory = core.getInput(`working-directory`);
     const cmdArgs = {};
+    const workingDirectory = core.getInput(`working-directory`);
     if (workingDirectory) {
         if (!fs.existsSync(workingDirectory) || !fs.lstatSync(workingDirectory).isDirectory()) {
             throw new Error(`working-directory (${workingDirectory}) was not a path`);
@@ -89338,7 +89341,7 @@ async function runLint(lintPath, patchPath) {
         cmdArgs.cwd = path.resolve(workingDirectory);
     }
     const cmd = `${lintPath} run ${addedArgs.join(` `)} ${userArgs}`.trimEnd();
-    core.info(`Running [${cmd}] in [${cmdArgs.cwd || ``}] ...`);
+    core.info(`Running [${cmd}] in [${cmdArgs.cwd || process.cwd()}] ...`);
     const startedAt = Date.now();
     try {
         const res = await execShellCommand(cmd, cmdArgs);

dist/run/index.js

@@ -88815,18 +88815,26 @@ const getLintCacheDir = () => {
 };
 const getIntervalKey = (invalidationIntervalDays) => {
     const now = new Date();
+    if (invalidationIntervalDays <= 0) {
+        return `${now.getTime()}`;
+    }
     const secondsSinceEpoch = now.getTime() / 1000;
     const intervalNumber = Math.floor(secondsSinceEpoch / (invalidationIntervalDays * 86400));
     return intervalNumber.toString();
 };
 async function buildCacheKeys() {
     const keys = [];
-    // Periodically invalidate a cache because a new code being added.
+    // Cache by OS.
-    // TODO: configure it via inputs.
+    let cacheKey = `golangci-lint.cache-${process.env?.RUNNER_OS}-`;
-    let cacheKey = `golangci-lint.cache-${getIntervalKey(7)}-`;
-    keys.push(cacheKey);
     // Get working directory from input
     const workingDirectory = core.getInput(`working-directory`);
+    if (workingDirectory) {
+        cacheKey += `${workingDirectory}-`;
+    }
+    // Periodically invalidate a cache because a new code being added.
+    const invalidationIntervalDays = parseInt(core.getInput(`cache-invalidation-interval`, { required: true }).trim());
+    cacheKey += `${getIntervalKey(invalidationIntervalDays)}-`;
+    keys.push(cacheKey);
     // create path to go.mod prepending the workingDirectory if it exists
     const goModPath = path_1.default.join(workingDirectory, `go.mod`);
     core.info(`Checking for go.mod: ${goModPath}`);
@@ -88841,7 +88849,7 @@ async function buildCacheKeys() {
     return keys;
 }
 async function restoreCache() {
-    if (core.getInput(`skip-cache`, { required: true }).trim() == "true")
+    if (core.getBooleanInput(`skip-cache`, { required: true }))
         return;
     if (!utils.isValidEvent()) {
         utils.logWarning(`Event Validation Error: The event type ${process.env[constants_1.Events.Key]} is not supported because it's not tied to a branch or tag ref.`);
@@ -88879,9 +88887,9 @@ async function restoreCache() {
 }
 exports.restoreCache = restoreCache;
 async function saveCache() {
-    if (core.getInput(`skip-cache`, { required: true }).trim() == "true")
+    if (core.getBooleanInput(`skip-cache`, { required: true }))
         return;
-    if (core.getInput(`skip-save-cache`, { required: true }).trim() == "true")
+    if (core.getBooleanInput(`skip-save-cache`, { required: true }))
         return;
     // Validate inputs, this can cause task failure
     if (!utils.isValidEvent()) {
@@ -89147,11 +89155,7 @@ const execShellCommand = (0, util_1.promisify)(child_process_1.exec);
 const writeFile = (0, util_1.promisify)(fs.writeFile);
 const createTempDir = (0, util_1.promisify)(tmp_1.dir);
 function isOnlyNewIssues() {
-    const onlyNewIssues = core.getInput(`only-new-issues`, { required: true }).trim();
+    return core.getBooleanInput(`only-new-issues`, { required: true });
-    if (onlyNewIssues !== `false` && onlyNewIssues !== `true`) {
-        throw new Error(`invalid value of "only-new-issues": "${onlyNewIssues}", expected "true" or "false"`);
-    }
-    return onlyNewIssues === `true`;
 }
 async function prepareLint() {
     const mode = core.getInput("install-mode").toLowerCase();
@@ -89221,11 +89225,10 @@ async function fetchPushPatch(ctx) {
     const octokit = github.getOctokit(core.getInput(`github-token`, { required: true }));
     let patch;
     try {
-        const patchResp = await octokit.rest.repos.compareCommits({
+        const patchResp = await octokit.rest.repos.compareCommitsWithBasehead({
             owner: ctx.repo.owner,
             repo: ctx.repo.repo,
-            base: ctx.payload.before,
+            basehead: `${ctx.payload.before}..${ctx.payload.after}`,
-            head: ctx.payload.after,
             mediaType: {
                 format: `diff`,
             },
@@ -89287,7 +89290,7 @@ async function runLint(lintPath, patchPath) {
         .map(([key, value]) => [key.toLowerCase(), value ?? ""]);
     const userArgsMap = new Map(userArgsList);
     const userArgNames = new Set(userArgsList.map(([key]) => key));
-    const annotations = core.getInput(`annotations`).trim() !== "false";
+    const annotations = core.getBooleanInput(`annotations`);
     if (annotations) {
         const formats = (userArgsMap.get("out-format") || "")
             .trim()
@@ -89326,8 +89329,8 @@ async function runLint(lintPath, patchPath) {
                 break;
         }
     }
-    const workingDirectory = core.getInput(`working-directory`);
     const cmdArgs = {};
+    const workingDirectory = core.getInput(`working-directory`);
     if (workingDirectory) {
         if (!fs.existsSync(workingDirectory) || !fs.lstatSync(workingDirectory).isDirectory()) {
             throw new Error(`working-directory (${workingDirectory}) was not a path`);
@@ -89338,7 +89341,7 @@ async function runLint(lintPath, patchPath) {
         cmdArgs.cwd = path.resolve(workingDirectory);
     }
     const cmd = `${lintPath} run ${addedArgs.join(` `)} ${userArgs}`.trimEnd();
-    core.info(`Running [${cmd}] in [${cmdArgs.cwd || ``}] ...`);
+    core.info(`Running [${cmd}] in [${cmdArgs.cwd || process.cwd()}] ...`);
     const startedAt = Date.now();
     try {
         const res = await execShellCommand(cmd, cmdArgs);

src/cache.ts

@@ -25,6 +25,11 @@ const getLintCacheDir = (): string => {
 
 const getIntervalKey = (invalidationIntervalDays: number): string => {
   const now = new Date()
+
+  if (invalidationIntervalDays <= 0) {
+    return `${now.getTime()}`
+  }
+
   const secondsSinceEpoch = now.getTime() / 1000
   const intervalNumber = Math.floor(secondsSinceEpoch / (invalidationIntervalDays * 86400))
   return intervalNumber.toString()
@@ -32,28 +37,42 @@ const getIntervalKey = (invalidationIntervalDays: number): string => {
 
 async function buildCacheKeys(): Promise<string[]> {
   const keys = []
-  // Periodically invalidate a cache because a new code being added.
+
-  // TODO: configure it via inputs.
+  // Cache by OS.
-  let cacheKey = `golangci-lint.cache-${getIntervalKey(7)}-`
+  let cacheKey = `golangci-lint.cache-${process.env?.RUNNER_OS}-`
-  keys.push(cacheKey)
+
   // Get working directory from input
   const workingDirectory = core.getInput(`working-directory`)
+
+  if (workingDirectory) {
+    cacheKey += `${workingDirectory}-`
+  }
+
+  // Periodically invalidate a cache because a new code being added.
+  const invalidationIntervalDays = parseInt(core.getInput(`cache-invalidation-interval`, { required: true }).trim())
+  cacheKey += `${getIntervalKey(invalidationIntervalDays)}-`
+
+  keys.push(cacheKey)
+
   // create path to go.mod prepending the workingDirectory if it exists
   const goModPath = path.join(workingDirectory, `go.mod`)
+
   core.info(`Checking for go.mod: ${goModPath}`)
+
   if (await pathExists(goModPath)) {
     // Add checksum to key to invalidate a cache when dependencies change.
     cacheKey += await checksumFile(`sha1`, goModPath)
   } else {
     cacheKey += `nogomod`
   }
+
   keys.push(cacheKey)
 
   return keys
 }
 
 export async function restoreCache(): Promise<void> {
-  if (core.getInput(`skip-cache`, { required: true }).trim() == "true") return
+  if (core.getBooleanInput(`skip-cache`, { required: true })) return
 
   if (!utils.isValidEvent()) {
     utils.logWarning(
@@ -95,8 +114,8 @@ export async function restoreCache(): Promise<void> {
 }
 
 export async function saveCache(): Promise<void> {
-  if (core.getInput(`skip-cache`, { required: true }).trim() == "true") return
+  if (core.getBooleanInput(`skip-cache`, { required: true })) return
-  if (core.getInput(`skip-save-cache`, { required: true }).trim() == "true") return
+  if (core.getBooleanInput(`skip-save-cache`, { required: true })) return
 
   // Validate inputs, this can cause task failure
   if (!utils.isValidEvent()) {

src/run.ts

@@ -17,13 +17,7 @@ const writeFile = promisify(fs.writeFile)
 const createTempDir = promisify(dir)
 
 function isOnlyNewIssues(): boolean {
-  const onlyNewIssues = core.getInput(`only-new-issues`, { required: true }).trim()
+  return core.getBooleanInput(`only-new-issues`, { required: true })
-
-  if (onlyNewIssues !== `false` && onlyNewIssues !== `true`) {
-    throw new Error(`invalid value of "only-new-issues": "${onlyNewIssues}", expected "true" or "false"`)
-  }
-
-  return onlyNewIssues === `true`
 }
 
 async function prepareLint(): Promise<string> {
@@ -104,11 +98,10 @@ async function fetchPushPatch(ctx: Context): Promise<string> {
 
   let patch: string
   try {
-    const patchResp = await octokit.rest.repos.compareCommits({
+    const patchResp = await octokit.rest.repos.compareCommitsWithBasehead({
       owner: ctx.repo.owner,
       repo: ctx.repo.repo,
-      base: ctx.payload.before,
+      basehead: `${ctx.payload.before}..${ctx.payload.after}`,
-      head: ctx.payload.after,
       mediaType: {
         format: `diff`,
       },
@@ -192,7 +185,7 @@ async function runLint(lintPath: string, patchPath: string): Promise<void> {
   const userArgsMap = new Map<string, string>(userArgsList)
   const userArgNames = new Set<string>(userArgsList.map(([key]) => key))
 
-  const annotations = core.getInput(`annotations`).trim() !== "false"
+  const annotations = core.getBooleanInput(`annotations`)
 
   if (annotations) {
     const formats = (userArgsMap.get("out-format") || "")
@@ -240,8 +233,9 @@ async function runLint(lintPath: string, patchPath: string): Promise<void> {
     }
   }
 
-  const workingDirectory = core.getInput(`working-directory`)
   const cmdArgs: ExecOptions = {}
+
+  const workingDirectory = core.getInput(`working-directory`)
   if (workingDirectory) {
     if (!fs.existsSync(workingDirectory) || !fs.lstatSync(workingDirectory).isDirectory()) {
       throw new Error(`working-directory (${workingDirectory}) was not a path`)
@@ -254,7 +248,7 @@ async function runLint(lintPath: string, patchPath: string): Promise<void> {
 
   const cmd = `${lintPath} run ${addedArgs.join(` `)} ${userArgs}`.trimEnd()
 
-  core.info(`Running [${cmd}] in [${cmdArgs.cwd || ``}] ...`)
+  core.info(`Running [${cmd}] in [${cmdArgs.cwd || process.cwd()}] ...`)
 
   const startedAt = Date.now()
   try {