Added the option to configure when the action should start reporting a new version

README.md

@@ -31,19 +31,48 @@ jobs:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
 ```
 
-By default, the app checks for readme in `readme.txt` and `plugin/readme.txt`. If the readme of your plugin is not in one of these locations, you can configure the app to look somewhere else by creating a file called `.wordpress-version-checker.json` in the root of your repo with the contents:
+## Configuration
+
+The app doesn't stricly require any configuration, however you can configure some aspects of its function by placing a file named `.wordpress-version-checker.json` in the root of your repository. The file may contain any of the following configuration options:
+
+### Plugin readme location.
+
+By default, the app checks for readme in `readme.txt` and `plugin/readme.txt`. If the readme of your plugin is not in one of these locations, you can configure the app to look somewhere else with the `readme` value in the configuration. The value can be either a single location or an array of locations to check - if multiple locations are provided, they will be checked in the given order until the first match.
+
+#### Examples
 
 ```json
 {
     "readme": "path/to/your/readme.txt"
 }
 ```
 
-If you want the issues to be automatically assigned to someone, you can put their GitHub usernames in the config as well:
+```json
+{
+    "readme": ["path/to/first/readme.txt", "path/to/second/readme.txt"]
+}
+```
+
+### WordPress release channel
+
+By default, the app will only notify you once the new WordPress version is released (**This will change** - starting from version 2.0, the default value will be changed to `rc`). By setting the `channel` value to one of `stable` or `rc`, you can choose to be notified when the new version is fully release, is in the release candidate (RC) stage of development or when the first beta versions are released.
+
+#### Example
+
+```json
+{
+    "channel": "rc"
+}
+```
+
+### Issue assignees
+
+By default, the issue will have no assignees. If you want the issues to be automatically assigned to someone, you can put their GitHub usernames in the config as the `assignees` value.
+
+#### Example
 
 ```json
 {
-    "readme": "path/to/your/readme.txt",
     "assignees": ["alice", "bob"]
 }
 ```

__tests__/issue-management.test.ts

@@ -3,14 +3,14 @@ import { mocked } from "jest-mock";
 import mockedEnv from "mocked-env";
 import nock from "nock";
 
-import { ExistingIssueFormatError } from "../src/exceptions/ExistingIssueFormatError";
 import { GetIssueError } from "../src/exceptions/GetIssueError";
 import { IssueCommentError } from "../src/exceptions/IssueCommentError";
 import { IssueCreationError } from "../src/exceptions/IssueCreationError";
 import { IssueListError } from "../src/exceptions/IssueListError";
 import { IssueUpdateError } from "../src/exceptions/IssueUpdateError";
 import {
   closeIssue,
+  commentOnIssue,
   createIssue,
   getIssue,
   updateIssue,
@@ -65,176 +65,198 @@ describe("[env variable mock]", () => {
     await expect(getIssue()).rejects.toThrow(IssueListError);
   });
 
-  test("closeIssue works correctly", async () => {
-    expect.assertions(1);
-    nock("https://api.github.com")
+  test("commentOnIssue works correctly", async () => {
+    expect.assertions(2);
+    const issueBody = "ISSUE_BODY";
+
+    const scope = nock("https://api.github.com")
       .post("/repos/OWNER/REPO/issues/123/comments", {
-        body: 'The "Tested up to" version in the readme matches the latest version now, closing this issue.',
-      })
-      .reply(200)
-      .patch("/repos/OWNER/REPO/issues/123", {
-        state: "closed",
+        body: issueBody,
       })
       .reply(200);
 
-    await expect(closeIssue(123)).resolves.toBeUndefined();
+    await expect(commentOnIssue(123, issueBody)).resolves.toBeUndefined();
+    expect(scope.isDone()).toBe(true);
   });
 
-  test("closeIssue fails gracefully on connection issues when commenting", async () => {
+  test("commentOnIssue fails gracefully on connection issues", async () => {
     expect.assertions(1);
-    await expect(closeIssue(123)).rejects.toThrow(IssueCommentError);
+    await expect(commentOnIssue(123, "ISSUE_BODY")).rejects.toThrow(
+      IssueCommentError
+    );
   });
 
-  test("closeIssue fails gracefully on nonexistent repo when commenting", async () => {
-    expect.assertions(1);
-    nock("https://api.github.com")
+  test("commentOnIssue fails gracefully on nonexistent repo", async () => {
+    expect.assertions(2);
+    const issueBody = "ISSUE_BODY";
+
+    const scope = nock("https://api.github.com")
       .post("/repos/OWNER/REPO/issues/123/comments", {
-        body: 'The "Tested up to" version in the readme matches the latest version now, closing this issue.',
+        body: issueBody,
       })
-      .reply(404)
+      .reply(404);
+
+    await expect(commentOnIssue(123, issueBody)).rejects.toThrow(
+      IssueCommentError
+    );
+    expect(scope.isDone()).toBe(true);
+  });
+
+  test("closeIssue works correctly", async () => {
+    expect.assertions(2);
+    const scope = nock("https://api.github.com")
       .patch("/repos/OWNER/REPO/issues/123", {
         state: "closed",
       })
-      .reply(404);
+      .reply(200);
 
-    await expect(closeIssue(123)).rejects.toThrow(IssueCommentError);
+    await expect(closeIssue(123)).resolves.toBeUndefined();
+    expect(scope.isDone()).toBe(true);
   });
 
-  test("closeIssue fails gracefully on connection issues when closing", async () => {
+  test("closeIssue fails gracefully on connection issues", async () => {
     expect.assertions(1);
-    nock("https://api.github.com")
-      .post("/repos/OWNER/REPO/issues/123/comments", {
-        body: 'The "Tested up to" version in the readme matches the latest version now, closing this issue.',
-      })
-      .reply(200);
     await expect(closeIssue(123)).rejects.toThrow(IssueUpdateError);
   });
 
-  test("closeIssue fails gracefully on nonexistent repo when closing", async () => {
-    expect.assertions(1);
-    nock("https://api.github.com")
-      .post("/repos/OWNER/REPO/issues/123/comments", {
-        body: 'The "Tested up to" version in the readme matches the latest version now, closing this issue.',
-      })
-      .reply(200)
+  test("closeIssue fails gracefully on nonexistent repo", async () => {
+    expect.assertions(2);
+    const scope = nock("https://api.github.com")
       .patch("/repos/OWNER/REPO/issues/123", {
         state: "closed",
       })
       .reply(404);
 
     await expect(closeIssue(123)).rejects.toThrow(IssueUpdateError);
+    expect(scope.isDone()).toBe(true);
   });
 
   test("createIssue works correctly", async () => {
     expect.assertions(2);
-    const config = {
-      readme: ["readme.txt"],
-      assignees: [],
-    };
+    const title = "ISSUE_TITLE";
+    const body = "ISSUE_BODY";
+    const assignees: Array<string> = [];
 
     const scope = nock("https://api.github.com")
       .post("/repos/OWNER/REPO/issues", {
-        title:
-          "The plugin hasn't been tested with the latest version of WordPress",
-        body: /.*/g,
+        title,
+        body,
         labels: ["wpvc"],
-        assignees: [],
+        assignees,
       })
       .reply(201);
 
-    await expect(createIssue(config, "0.41", "0.42")).resolves.toBeUndefined();
+    await expect(createIssue(title, body, assignees)).resolves.toBeUndefined();
     expect(scope.isDone()).toBe(true);
   });
 
   test("createIssue works correctly with assignees", async () => {
     expect.assertions(2);
-    const config = {
-      readme: ["readme.txt"],
-      assignees: ["PERSON1", "PERSON2"],
-    };
+    const title = "ISSUE_TITLE";
+    const body = "ISSUE_BODY";
+    const assignees = ["PERSON1", "PERSON2"];
 
     const scope = nock("https://api.github.com")
       .post("/repos/OWNER/REPO/issues", {
-        title:
-          "The plugin hasn't been tested with the latest version of WordPress",
-        body: /.*/g,
+        title,
+        body,
         labels: ["wpvc"],
-        assignees: ["PERSON1", "PERSON2"],
+        assignees,
       })
       .reply(201);
 
-    await expect(createIssue(config, "0.41", "0.42")).resolves.toBeUndefined();
+    await expect(createIssue(title, body, assignees)).resolves.toBeUndefined();
     expect(scope.isDone()).toBe(true);
   });
 
   test("createIssue fails gracefully on connection issues", async () => {
     expect.assertions(1);
-    const config = {
-      readme: ["readme.txt"],
-      assignees: ["PERSON1", "PERSON2"],
-    };
 
-    await expect(createIssue(config, "0.41", "0.42")).rejects.toThrow(
+    await expect(createIssue("ISSUE_TITLE", "ISSUE_BODY", [])).rejects.toThrow(
       IssueCreationError
     );
   });
 
   test("createIssue fails gracefully on nonexistent repo", async () => {
     expect.assertions(1);
-    const config = {
-      readme: ["readme.txt"],
-      assignees: ["PERSON1", "PERSON2"],
-    };
 
     nock("https://api.github.com").post("/repos/OWNER/REPO/issues").reply(404);
 
-    await expect(createIssue(config, "0.41", "0.42")).rejects.toThrow(
+    await expect(createIssue("ISSUE_TITLE", "ISSUE_BODY", [])).rejects.toThrow(
       IssueCreationError
     );
   });
 
-  test("updateIssue works correctly", async () => {
+  test("updateIssue works correctly with an up-to-date-issue", async () => {
     expect.assertions(2);
+    const title = "ISSUE_TITLE";
+    const body = "ISSUE_BODY";
+
     const scope = nock("https://api.github.com")
       .get("/repos/OWNER/REPO/issues/123")
-      .reply(200, { body: "**Latest version:** 0.42" })
-      .patch("/repos/OWNER/REPO/issues/123")
+      .reply(200, { title, body });
+    //.patch("/repos/OWNER/REPO/issues/123")
+    //.reply(200);
+
+    await expect(updateIssue(123, title, body)).resolves.toBeUndefined();
+    expect(scope.isDone()).toBe(true);
+  });
+
+  test("updateIssue works correctly with an issue with outdated title", async () => {
+    expect.assertions(2);
+    const title = "ISSUE_TITLE";
+    const body = "ISSUE_BODY";
+
+    const scope = nock("https://api.github.com")
+      .get("/repos/OWNER/REPO/issues/123")
+      .reply(200, { title: "WRONG_TITLE", body })
+      .patch("/repos/OWNER/REPO/issues/123", { title, body })
       .reply(200);
 
-    await expect(updateIssue(123, "0.41", "0.43")).resolves.toBeUndefined();
+    await expect(updateIssue(123, title, body)).resolves.toBeUndefined();
     expect(scope.isDone()).toBe(true);
   });
 
-  test("updateIssue correctly does not update the issue if it isn't needed", async () => {
+  test("updateIssue works correctly with an issue with outdated body", async () => {
     expect.assertions(2);
+    const title = "ISSUE_TITLE";
+    const body = "ISSUE_BODY";
+
     const scope = nock("https://api.github.com")
       .get("/repos/OWNER/REPO/issues/123")
-      .reply(200, { body: "**Latest version:** 0.42" });
+      .reply(200, { title, body: "WRONG_BODY" })
+      .patch("/repos/OWNER/REPO/issues/123", { title, body })
+      .reply(200);
 
-    await expect(updateIssue(123, "0.41", "0.42")).resolves.toBeUndefined();
+    await expect(updateIssue(123, title, body)).resolves.toBeUndefined();
     expect(scope.isDone()).toBe(true);
   });
 
   test("updateIssue fails gracefully on connection issues on getting the existing issue", async () => {
     expect.assertions(1);
+    const title = "ISSUE_TITLE";
+    const body = "ISSUE_BODY";
+
     nock("https://api.github.com")
-      .patch("/repos/OWNER/REPO/issues/123")
+      .patch("/repos/OWNER/REPO/issues/123", { title, body })
       .reply(200);
 
-    await expect(updateIssue(123, "0.41", "0.43")).rejects.toThrow(
-      GetIssueError
-    );
+    await expect(updateIssue(123, title, body)).rejects.toThrow(GetIssueError);
   });
 
   test("updateIssue fails gracefully on connection issues on updating the existing issue", async () => {
-    expect.assertions(1);
-    nock("https://api.github.com")
+    expect.assertions(2);
+    const title = "ISSUE_TITLE";
+    const body = "ISSUE_BODY";
+
+    const scope = nock("https://api.github.com")
       .get("/repos/OWNER/REPO/issues/123")
-      .reply(200, { body: "**Latest version:** 0.42" });
+      .reply(200, { title: "WRONG_TITLE", body });
 
-    await expect(updateIssue(123, "0.41", "0.43")).rejects.toThrow(
+    await expect(updateIssue(123, title, body)).rejects.toThrow(
       IssueUpdateError
     );
+    expect(scope.isDone()).toBe(true);
   });
 
   test("updateIssue fails gracefully on nonexistent repo", async () => {
@@ -245,30 +267,8 @@ describe("[env variable mock]", () => {
       .patch("/repos/OWNER/REPO/issues/123")
       .reply(404);
 
-    await expect(updateIssue(123, "0.41", "0.43")).rejects.toThrow(
+    await expect(updateIssue(123, "ISSUE_TITLE", "ISSUE_BODY")).rejects.toThrow(
       GetIssueError
     );
   });
-
-  test("updateIssue fails gracefully on malformed issue 1", async () => {
-    expect.assertions(1);
-    nock("https://api.github.com")
-      .get("/repos/OWNER/REPO/issues/123")
-      .reply(200, {});
-
-    await expect(updateIssue(123, "0.41", "0.43")).rejects.toThrow(
-      ExistingIssueFormatError
-    );
-  });
-
-  test("updateIssue fails gracefully on malformed issue 2", async () => {
-    expect.assertions(1);
-    nock("https://api.github.com")
-      .get("/repos/OWNER/REPO/issues/123")
-      .reply(200, { body: "**Latest NOT version:** 0.42" });
-
-    await expect(updateIssue(123, "0.41", "0.43")).rejects.toThrow(
-      ExistingIssueFormatError
-    );
-  });
 });