Merge pull request #1 from wp-media/test/adaptation-to-WPMedia-template

Initial adaptation to WP Media template

Author: MathieuLamiot

README.md

@@ -1,49 +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 }}"
+          repo-token: "${{ secrets.PR_CHECKLIST_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
-```
-
-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,9 +1,9 @@
-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: "node12"
+  using: "node20"
   main: "dist/index.js"