Rename isbn input to identifier (#166)

* Rename `isbn` input to `identifier` * Update documentation --------- Co-authored-by: GitHub Action <[email protected]>
library-pals · May 25, 2024 · 4facb03 · 4facb03
1 parent 192a8d8
commit 4facb03
Show file tree

Hide file tree

Showing 16 changed files with 77 additions and 71 deletions.
diff --git a/.github/workflows/read-advanced.yml b/.github/workflows/read-advanced.yml
@@ -23,7 +23,7 @@ on:
       date:
         description: Date to record the status of the book (YYYY-MM-DD). Leave blank for today. Optional.
         type: string
-      isbn:
+      identifier:
         description: The book's ISBN. Required.
         required: true
         type: string

diff --git a/.github/workflows/read-thumbnail.yml b/.github/workflows/read-thumbnail.yml
@@ -9,7 +9,7 @@ permissions:
 on:
   workflow_dispatch:
     inputs:
-      isbn:
+      identifier:
         description: The book's ISBN. Required.
         required: true
         type: string

diff --git a/.github/workflows/read.yml b/.github/workflows/read.yml
@@ -9,7 +9,7 @@ permissions:
 on:
   workflow_dispatch:
     inputs:
-      isbn:
+      identifier:
         description: The book's ISBN. Required.
         required: true
         type: string

diff --git a/README.md b/README.md
@@ -28,7 +28,7 @@ permissions:
 on:
   workflow_dispatch:
     inputs:
-      isbn:
+      identifier:
         description: The book's ISBN. Required.
         required: true
         type: string
@@ -119,7 +119,7 @@ on:
       date:
         description: Date to record the status of the book (YYYY-MM-DD). Leave blank for today. Optional.
         type: string
-      isbn:
+      identifier:
         description: The book's ISBN. Required.
         required: true
         type: string
@@ -215,7 +215,7 @@ permissions:
 on:
   workflow_dispatch:
     inputs:
-      isbn:
+      identifier:
         description: The book's ISBN. Required.
         required: true
         type: string
@@ -306,7 +306,7 @@ To trigger the action, [create a workflow dispatch event](https://docs.github.co
 {
   "ref": "main", // Required. The git reference for the workflow, a branch or tag name.
   "inputs": {
-    "isbn": "", // Required. The book's ISBN. Required.
+    "identifier": "", // Required. The book's ISBN. Required.
     "book-status": "", // Required. What is the status of the book? Required. Default: `want to read`.
     "date": "", // Date to record the status of the book (YYYY-MM-DD). Leave blank for today. Optional.
     "notes": "", // Notes about the book. Optional.

diff --git a/src/__tests__/checkout-book.test.ts b/src/__tests__/checkout-book.test.ts
@@ -23,7 +23,7 @@ describe("checkOutBook", () => {
       checkOutBook(
         {
           fileName: "my-library.yml",
-          bookIsbn: "9780525620792",
+          inputIdentifier: "9780525620792",
           dates: {
             dateAdded: undefined,
             dateStarted: undefined,
@@ -50,7 +50,7 @@ describe("checkOutBook", () => {
       checkOutBook(
         {
           fileName: "my-library.yml",
-          bookIsbn: "9780525620792",
+          inputIdentifier: "9780525620792",
           dates: {
             dateAdded: undefined,
             dateStarted: undefined,
@@ -70,7 +70,7 @@ describe("checkOutBook", () => {
       checkOutBook(
         {
           fileName: "my-library.yml",
-          bookIsbn: "9780525620792",
+          inputIdentifier: "9780525620792",
           tags: [""],
           dates: {
             dateAdded: undefined,
@@ -91,7 +91,7 @@ describe("checkOutBook", () => {
       checkOutBook(
         {
           fileName: "my-library.yml",
-          bookIsbn: "12345",
+          inputIdentifier: "12345",
           dates: {
             dateAdded: undefined,
             dateStarted: undefined,
@@ -110,7 +110,7 @@ describe("checkOutBook", () => {
       checkOutBook(
         {
           fileName: "my-library.yml",
-          bookIsbn: "12345",
+          inputIdentifier: "12345",
           dates: {
             dateAdded: undefined,
             dateStarted: undefined,

diff --git a/src/__tests__/clean-book.test.ts b/src/__tests__/clean-book.test.ts
@@ -26,7 +26,7 @@ describe("cleanBook", () => {
         {
           dateType: { dateFinished: dateFinished },
           notes: "I loved it!",
-          bookIsbn: "0525658181",
+          inputIdentifier: "0525658181",
           providers: [],
           bookStatus: "finished",
           filename: "_data/read.yml",
@@ -67,7 +67,7 @@ describe("cleanBook", () => {
         {
           dateType: { dateFinished: dateFinished },
           notes: "I loved it!",
-          bookIsbn: "0525658181",
+          inputIdentifier: "0525658181",
           providers: [],
           bookStatus: "finished",
           rating: "⭐️⭐️⭐️⭐️⭐️",
@@ -109,7 +109,7 @@ describe("cleanBook", () => {
       cleanBook(
         {
           notes: "I loved it!",
-          bookIsbn: "0525658181",
+          inputIdentifier: "0525658181",
           providers: [],
           bookStatus: "finished",
           filename: "_data/read.yml",
@@ -149,7 +149,7 @@ describe("cleanBook", () => {
     cleanBook(
       {
         dateType: { dateStarted: "2022-01-01" },
-        bookIsbn: "1234597890",
+        inputIdentifier: "1234597890",
         providers: [],
         bookStatus: "started",
         filename: "_data/read.yml",
@@ -182,7 +182,7 @@ describe("cleanBook", () => {
           "authors, description",
         ],
         [
-          "BookIsbn",
+          "BookIdentifier",
           "1234597890",
         ],
       ]
@@ -195,7 +195,7 @@ describe("cleanBook", () => {
     cleanBook(
       {
         dateType: { dateStarted: "2022-01-01" },
-        bookIsbn: "1234597890",
+        inputIdentifier: "1234597890",
         providers: [],
         bookStatus: "started",
         filename: "_data/read.yml",
@@ -229,7 +229,7 @@ describe("cleanBook", () => {
           "title",
         ],
         [
-          "BookIsbn",
+          "BookIdentifier",
           "1234597890",
         ],
       ]
@@ -242,7 +242,7 @@ describe("cleanBook", () => {
     cleanBook(
       {
         dateType: { dateStarted: "2022-01-01" },
-        bookIsbn: "1234597890",
+        inputIdentifier: "1234597890",
         providers: [],
         bookStatus: "started",
         filename: "_data/read.yml",
@@ -276,7 +276,7 @@ describe("cleanBook", () => {
           "description",
         ],
         [
-          "BookIsbn",
+          "BookIdentifier",
           "1234597890",
         ],
       ]
@@ -289,7 +289,7 @@ describe("cleanBook", () => {
     cleanBook(
       {
         dateType: { dateStarted: "2022-01-01" },
-        bookIsbn: "1234597890",
+        inputIdentifier: "1234597890",
         providers: [],
         bookStatus: "started",
         filename: "_data/read.yml",
@@ -321,7 +321,7 @@ describe("cleanBook", () => {
           "title, pageCount, authors, description",
         ],
         [
-          "BookIsbn",
+          "BookIdentifier",
           "1234597890",
         ],
       ]
@@ -339,7 +339,7 @@ describe("cleanBook", () => {
     cleanBook(
       {
         dateType: { dateStarted: "2022-01-01" },
-        bookIsbn: "1234597890",
+        inputIdentifier: "1234597890",
         providers: [],
         bookStatus: "started",
         filename: "_data/read.yml",
@@ -365,7 +365,7 @@ describe("cleanBook", () => {
         {
           dateType: { dateFinished: dateFinished },
           notes: "I loved it!",
-          bookIsbn: "0525658181",
+          inputIdentifier: "0525658181",
           providers: [],
           bookStatus: "finished",
           filename: "_data/read.yml",
@@ -409,7 +409,7 @@ describe("cleanBook", () => {
         {
           dateType: { dateFinished: dateFinished },
           notes: "I loved it!",
-          bookIsbn: "0525658181",
+          inputIdentifier: "0525658181",
           providers: [],
           bookStatus: "finished",
           filename: "_data/read.yml",
@@ -453,7 +453,7 @@ describe("cleanBook", () => {
         {
           dateType: { dateFinished },
           notes: "I loved it!",
-          bookIsbn: "0525658181",
+          inputIdentifier: "0525658181",
           providers: [],
           bookStatus: "finished",
           filename: "_data/read.yml",

diff --git a/src/__tests__/get-book.test.ts b/src/__tests__/get-book.test.ts
@@ -32,7 +32,7 @@ describe("getBook", () => {
         dateType: {
           dateFinished,
         },
-        bookIsbn: "9780525658184",
+        inputIdentifier: "9780525658184",
         providers: ["google"],
         bookStatus: "finished",
         filename: "_data/read.yml",
@@ -74,7 +74,7 @@ describe("getBook", () => {
           dateStarted: undefined,
           dateFinished,
         },
-        bookIsbn: "9780525658184",
+        inputIdentifier: "9780525658184",
         providers: ["google"],
         bookStatus: "finished",
         filename: "_data/read.json",

diff --git a/src/__tests__/index.test.ts b/src/__tests__/index.test.ts
@@ -65,7 +65,7 @@ describe("index", () => {
       value: {
         payload: {
           inputs: {
-            isbn: "9780385696005",
+            identifier: "9780385696005",
             "book-status": "started",
             date: "2022-01-02",
           },
@@ -88,7 +88,7 @@ describe("index", () => {
           "pageCount",
         ],
         [
-          "BookIsbn",
+          "BookIdentifier",
           "9780385696005",
         ],
         [
@@ -177,7 +177,7 @@ describe("index", () => {
       value: {
         payload: {
           inputs: {
-            isbn: "9780525620792",
+            identifier: "9780525620792",
             "book-status": "finished",
             date: "2021-09-30",
           },
@@ -235,7 +235,7 @@ describe("index", () => {
       value: {
         payload: {
           inputs: {
-            isbn: "9780525511342",
+            identifier: "9780525511342",
             "book-status": "finished",
             date: "2022-08-02",
           },
@@ -323,7 +323,7 @@ describe("index", () => {
       value: {
         payload: {
           inputs: {
-            isbn: "9780385696005",
+            identifier: "9780385696005",
             "book-status": "want to read",
           },
         },
@@ -345,7 +345,7 @@ describe("index", () => {
           "pageCount",
         ],
         [
-          "BookIsbn",
+          "BookIdentifier",
           "9780385696005",
         ],
         [
@@ -422,10 +422,12 @@ describe("index", () => {
     });
 
     await read();
-    expect(setFailedSpy).toHaveBeenCalledWith("Missing `isbn` in payload");
+    expect(setFailedSpy).toHaveBeenCalledWith(
+      "Missing `identifier` in payload"
+    );
   });
 
-  test("error, missing isbn", async () => {
+  test("error, missing identifier", async () => {
     const setFailedSpy = jest.spyOn(core, "setFailed");
     Object.defineProperty(github, "context", {
       value: {
@@ -438,7 +440,9 @@ describe("index", () => {
       },
     });
     await read();
-    expect(setFailedSpy).toHaveBeenCalledWith("Missing `isbn` in payload");
+    expect(setFailedSpy).toHaveBeenCalledWith(
+      "Missing `identifier` in payload"
+    );
   });
 
   test("error, setFailed", async () => {
@@ -447,7 +451,7 @@ describe("index", () => {
       value: {
         payload: {
           inputs: {
-            isbn: "9780385696005",
+            identifier: "9780385696005",
             "book-status": "want to read",
           },
         },
@@ -467,7 +471,7 @@ describe("index", () => {
       value: {
         payload: {
           inputs: {
-            isbn: "9780385696005",
+            identifier: "9780385696005",
             tags: "new, recommend",
             "book-status": "want to read",
           },
@@ -535,7 +539,7 @@ describe("index", () => {
       value: {
         payload: {
           inputs: {
-            isbn: "9780385696005",
+            identifier: "9780385696005",
             "book-status": "finished",
             date: "2022-02-02",
           },
@@ -552,7 +556,7 @@ describe("index", () => {
       value: {
         payload: {
           inputs: {
-            isbn: "9780385696005",
+            identifier: "9780385696005",
             "book-status": "finished",
             date: "1234",
           },
@@ -571,7 +575,7 @@ describe("index", () => {
       value: {
         payload: {
           inputs: {
-            isbn: "9780385696005",
+            identifier: "9780385696005",
             "book-status": "did not finish",
           },
         },