Merge pull request #9 from Telefonica/release

Release v1.0.1

Author: javierbrea

.github/actions/check-and-comment/action.yml

@@ -42,7 +42,7 @@ runs:
   steps:
     - name: Check SPDX headers
       id: check-spdx-headers
-      uses: Telefonica/check-spdx-headers@v1.0.0
+      uses: Telefonica/check-spdx-headers@v1.0.1
       with:
         rules: ${{ inputs.rules }}
         ignore: ${{ inputs.ignore }}

CHANGELOG.md

@@ -11,6 +11,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 #### Deprecated
 #### Removed
 
+## [1.0.1] - 2025-01-17
+
+### Fixed
+
+* fix: Ensure that paths correspond to files before trying to read them
+
 ## [1.0.0] - 2025-01-17
 
 ### Added

dist/index.js

@@ -1,7 +1,7 @@
 {
   "name": "@tid-xcut/check-spdx-headers",
   "description": "Checks that files have the correct SPDX headers",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "author": "Telefónica Innovación Digital",
   "homepage": "https://github.com/Telefonica/check-spdx-headers",
   "repository": {

dist/index.js.map

@@ -123,6 +123,7 @@ export class Checker {
     copyright: string | string[],
   ): Promise<string | null> {
     this._logger.silly(`Checking file copyright`, { file, copyright });
+    const stats = await stat(file);
 
     const approvedCopyrights = Array.isArray(copyright)
       ? copyright
@@ -131,29 +132,33 @@ export class Checker {
     if (!approvedCopyrights.length) {
       return null;
     }
+    if (stats.isFile()) {
+      const fileContent = await readFile(file, "utf-8");
 
-    const fileContent = await readFile(file, "utf-8");
+      const spdxCopyright = this._getSPDXHeader(
+        fileContent,
+        "FileCopyrightText",
+      );
 
-    const spdxCopyright = this._getSPDXHeader(fileContent, "FileCopyrightText");
+      if (!spdxCopyright) {
+        const message = `Does not have a copyright`;
+        this.logger.debug(`File "${file}" ${message.toLowerCase()}`);
+        return message;
+      }
 
-    if (!spdxCopyright) {
-      const message = `Does not have a copyright`;
-      this.logger.debug(`File "${file}" ${message.toLowerCase()}`);
-      return message;
-    }
+      const matches = approvedCopyrights.some((approvedCopyright) => {
+        const matcher = new RegExp(`^${approvedCopyright}$`);
+        if (!matcher.test(spdxCopyright)) {
+          return false;
+        }
+        return true;
+      });
 
-    const matches = approvedCopyrights.some((approvedCopyright) => {
-      const matcher = new RegExp(`^${approvedCopyright}$`);
-      if (!matcher.test(spdxCopyright)) {
-        return false;
+      if (!matches) {
+        const message = `Does not have the expected copyright`;
+        this.logger.debug(`File "${file}" ${message.toLowerCase()}`);
+        return message;
       }
-      return true;
-    });
-
-    if (!matches) {
-      const message = `Does not have the expected copyright`;
-      this.logger.debug(`File "${file}" ${message.toLowerCase()}`);
-      return message;
     }
 
     return null;