Update readme, definition and documentation

Author: MathieuLamiot

README.md

@@ -1,55 +1,45 @@
-# PR TaskList Completed Checker Action
-A GitHub action that checks if all tasks are completed in the pull requests.
+# WP Media PR Checklist Action
+A GitHub action that performs checks on PR descriptions, according to WP Media PR template from https://github.com/wp-media/.github.
+
+This action runs the following tests:
+- Description contains at least one text line that is not the one of the template.
+- Documentation contains at least one text line that is not one from the template.
+- At least one type of change is set.
+- All items in the checklist are ticked.
 
 ## Usage
 
 ### Create a workflow
 ```yml
-name: 'PR TaskList Completed Checker'
+name: 'PR Checklist'
 on: 
   pull_request:
     types: [edited, opened, synchronize, reopened]
 
 jobs:
-  task-check:
+  pr-checklist:
     runs-on: ubuntu-latest
     steps:
-      - uses: venkatsarvesh/pr-tasks-completed-action@v1.0.0
+      - uses: wp-media/pr-checklist-action@test/adaptation-to-WPMedia-template
         with:
-          repo-token: "${{ secrets.GITHUB_TOKEN }}"
-```
-
-### Check whether tasks are completed
-Add a pull request template to your repository (`.github/pull_request_template.md`).
-
-For example: 
-```markdown
-## Checklist
-- [ ] Completed code review
-- [ ] Ran unit tests
-- [ ] Completed e2e tests
-*Delete options that are not relevant.*
-
-- [ ] New feature (non-breaking change which adds functionality).
-- [ ] Bug fix (non-breaking change which fixes an issue).
-- [ ] Enhancement (non-breaking change which improves an existing functionality).
-- [ ] Breaking change (fix or feature that would cause existing functionality to not work as before).
+          repo-token: "${{ secrets.PR_CHECKLIST_TOKEN }}"
 ```
 
-Create a pull request that contained tasks list to your repository. This will start a workflow automatically to check whether tasks are completed.
-
-Every update on a pull request will start a new workflow automatically to check pending tasks.
+### Token
 
-All tasks completed:
-![All tasks completed](images/success.png)
+The PR_CHECKLIST_TOKEN must provide read access to Pull Requests of the repository this action is used in.
 
-Some tasks are still pending:
+### Making the check mandatory to merge
 
-![Some tasks are still pending](images/failure.png)
+Once the workflow file is commited, you can make the success mandatory before merging through branch protection:
+- Require status checks to pass before merging
+  - Require branches to be up to date before merging
+    - Search and select `pr-checklist`
 
-You can check a list of uncompleted tasks at the Actions page on clicking Details.
-![List of pending tasks](images/pending_tasks.png)
+## Build
 
+Modification to the sources must be done in the `src` folder.
+Once the changes are done, `run npm run build && npm run pack` to update the `lib` & `dist` folder.
 
 ## :memo: Licence
-MIT
+MIT

action.yml

@@ -1,8 +1,8 @@
-name: "PR TaskList Completed Checker"
-description: "An action that checks if all the tasks(if any) in the PR body are completed"
+name: "WP Media PR Checklist Action"
+description: "A GitHub action that performs checks on PR descriptions, according to WP Media PR template"
 inputs:
   repo-token:
-    description: "The GITHUB_TOKEN secret"
+    description: "The PR_CHECKLIST_TOKEN secret token with read access to Pull Requests."
     required: true
 runs:
   using: "node20"

dist/index.js

@@ -20,17 +20,9 @@ const core = __nccwpck_require__(9935);
 const github = __nccwpck_require__(2835);
 const utils_1 = __nccwpck_require__(963);
 /**
- * This action will
- * 1. Read the PR body
- * 2. Get all the tasks
- * 3. Checks if all tasks are completed(checked)
- * 4. Return
- *      success if
- *          there is no pr body
- *          no tasks in pr body
- *          all tasks are completed(checked)
- *      failure if
- *          there are any pending tasks to be complated
+ * This action will retrieve the PR body and
+ * run custom tests. If one of them fails,
+ * the action fails and returns immediately.
  */
 function run() {
     var _a;
@@ -158,10 +150,10 @@ run();
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 class Util {
     /**
-     * This method will read the input string and match it with uncheck mark([ ]).
+     * This method will read the input string and match it with uncheck mark(- [ ]).
      * Gets the pending tasks
      *
-     * @param body PR body that has tasks
+     * @param body PR body portion that has tasks
      *
      * Returns
      *  empty string if there are no pending tasks
@@ -187,10 +179,10 @@ class Util {
         return responseString;
     }
     /**
-     * This method will read the input string and match it with check mark([x]).
+     * This method will read the input string and match it with check mark(- [x]).
      * Gets the completed tasks
      *
-     * @param body PR body that has tasks
+     * @param body PR body portion that has tasks
      *
      * Returns
      *  empty string if there are no completed tasks
@@ -216,14 +208,14 @@ class Util {
         return responseString;
     }
     /**
-     * This method will read the input string and match it with check mark([x]).
-     * Gets the completed tasks
+     * This method will extract the portion from a string between start and end strings.
      *
-     * @param body PR body that has tasks
+     * @param body The main string to extract from
+     * @param startString The beginning of the portion to isolate. It will be excluded from the result.
+     * @param endString optional The end of the portion to isolate. It will be excluded from the result. If not provided, the portion will go until end of file.
      *
      * Returns
-     *  empty string if there are no completed tasks
-     *  completed tasks string
+     *  If found, the sub-string in between startString and endString. Otherwise, an empty string.
      */
     static extractString(body, startString, endString) {
         const startIndex = body.indexOf(startString);

lib/index.js

@@ -13,17 +13,9 @@ const core = require("@actions/core");
 const github = require("@actions/github");
 const utils_1 = require("./utils");
 /**
- * This action will
- * 1. Read the PR body
- * 2. Get all the tasks
- * 3. Checks if all tasks are completed(checked)
- * 4. Return
- *      success if
- *          there is no pr body
- *          no tasks in pr body
- *          all tasks are completed(checked)
- *      failure if
- *          there are any pending tasks to be complated
+ * This action will retrieve the PR body and
+ * run custom tests. If one of them fails,
+ * the action fails and returns immediately.
  */
 function run() {
     var _a;

lib/utils.js

@@ -2,10 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 class Util {
     /**
-     * This method will read the input string and match it with uncheck mark([ ]).
+     * This method will read the input string and match it with uncheck mark(- [ ]).
      * Gets the pending tasks
      *
-     * @param body PR body that has tasks
+     * @param body PR body portion that has tasks
      *
      * Returns
      *  empty string if there are no pending tasks
@@ -31,10 +31,10 @@ class Util {
         return responseString;
     }
     /**
-     * This method will read the input string and match it with check mark([x]).
+     * This method will read the input string and match it with check mark(- [x]).
      * Gets the completed tasks
      *
-     * @param body PR body that has tasks
+     * @param body PR body portion that has tasks
      *
      * Returns
      *  empty string if there are no completed tasks
@@ -60,14 +60,14 @@ class Util {
         return responseString;
     }
     /**
-     * This method will read the input string and match it with check mark([x]).
-     * Gets the completed tasks
+     * This method will extract the portion from a string between start and end strings.
      *
-     * @param body PR body that has tasks
+     * @param body The main string to extract from
+     * @param startString The beginning of the portion to isolate. It will be excluded from the result.
+     * @param endString optional The end of the portion to isolate. It will be excluded from the result. If not provided, the portion will go until end of file.
      *
      * Returns
-     *  empty string if there are no completed tasks
-     *  completed tasks string
+     *  If found, the sub-string in between startString and endString. Otherwise, an empty string.
      */
     static extractString(body, startString, endString) {
         const startIndex = body.indexOf(startString);

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "pr-tasks-completed-action",
+  "name": "wpm-pr-checklist-action",
   "version": "1.0.0",
   "description": "",
   "main": "index.js",
@@ -10,15 +10,15 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/venkatsarvesh/pr-tasks-completed-action.git"
+    "url": "git+https://github.com/wp-media/pr-checklist-action.git"
   },
   "keywords": [],
   "author": "",
   "license": "ISC",
   "bugs": {
-    "url": "https://github.com/venkatsarvesh/pr-tasks-completed-action/issues"
+    "url": "https://github.com/wp-media/pr-checklist-action/issues"
   },
-  "homepage": "https://github.com/venkatsarvesh/pr-tasks-completed-action#readme",
+  "homepage": "https://github.com/wp-media/pr-checklist-action#readme",
   "dependencies": {
     "@actions/core": "^1.2.4",
     "@actions/github": "^4.0.0",

src/index.ts

@@ -3,17 +3,9 @@ import * as github from '@actions/github'
 import Util from './utils'
 
 /**
- * This action will
- * 1. Read the PR body
- * 2. Get all the tasks
- * 3. Checks if all tasks are completed(checked)
- * 4. Return 
- *      success if
- *          there is no pr body 
- *          no tasks in pr body
- *          all tasks are completed(checked) 
- *      failure if 
- *          there are any pending tasks to be complated
+ * This action will retrieve the PR body and
+ * run custom tests. If one of them fails,
+ * the action fails and returns immediately.
  */
 
 async function run(): Promise<void> {
@@ -26,6 +18,7 @@ async function run(): Promise<void> {
             core.info("PR don't have tasks to check");
             return
         }
+
         // Ensure Description is modified
         core.debug('Checking Description...');
         let startString = "# Description";
@@ -90,7 +83,6 @@ async function run(): Promise<void> {
             core.setFailed(`Type of change section not found.`);
             return;
         }
-
         // get ticked tasks
         core.debug('Getting a list of ticked tasks: ');
         let typeOfChange = Util.getCompletedTasks(typeOfChangePortion);
@@ -114,8 +106,7 @@ async function run(): Promise<void> {
             core.setFailed(`Checklist section not found.`);
             return;
         }
-
-        // get ticked tasks
+        // get unticked tasks
         core.debug('Getting a list of unticked tasks: ');
         let uncompletedTasks = Util.getUncompletedTasks(checklistPortion);
         core.debug(uncompletedTasks);

src/utils.ts

@@ -1,10 +1,10 @@
 export default class Util {
 
     /**
-     * This method will read the input string and match it with uncheck mark([ ]).
+     * This method will read the input string and match it with uncheck mark(- [ ]).
      * Gets the pending tasks
      * 
-     * @param body PR body that has tasks
+     * @param body PR body portion that has tasks
      * 
      * Returns 
      *  empty string if there are no pending tasks
@@ -33,10 +33,10 @@ export default class Util {
         return responseString;
     }
     /**
-     * This method will read the input string and match it with check mark([x]).
+     * This method will read the input string and match it with check mark(- [x]).
      * Gets the completed tasks
      * 
-     * @param body PR body that has tasks
+     * @param body PR body portion that has tasks
      * 
      * Returns 
      *  empty string if there are no completed tasks
@@ -65,14 +65,14 @@ export default class Util {
         return responseString;
     }
     /**
-     * This method will read the input string and match it with check mark([x]).
-     * Gets the completed tasks
+     * This method will extract the portion from a string between start and end strings.
      * 
-     * @param body PR body that has tasks
+     * @param body The main string to extract from
+     * @param startString The beginning of the portion to isolate. It will be excluded from the result.
+     * @param endString optional The end of the portion to isolate. It will be excluded from the result. If not provided, the portion will go until end of file.
      * 
      * Returns 
-     *  empty string if there are no completed tasks
-     *  completed tasks string
+     *  If found, the sub-string in between startString and endString. Otherwise, an empty string.
      */
     static extractString(body: string, startString: string, endString?: string): string {
         const startIndex = body.indexOf(startString);