Feature | Issue #16 | GitHub Action Added

.github/workflows/test.yml

@@ -1,6 +1,7 @@
 name: 'build-test'
 on: # rebuild any PRs and main branch changes
   pull_request:
+    types: [opened, edited, synchronize, reopened]
   push:
     branches:
       - main
@@ -10,15 +11,15 @@ jobs:
   build: # make sure build/ci work properly
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - run: |
           npm install
       - run: |
           npm run all
   test: # make sure the action works on a clean machine without building
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ./
         with:
-          milliseconds: 1000
+          token: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -1,105 +1,169 @@
+<h1 align="center">PR Keeper</h1>
+
+<!-- PROJECT SHIELDS -->
 <p align="center">
+  <!-- <a href="package_link_here">
+    <img src="https://img.shields.io/badge/node-18.x.x-brightgreen.svg" alt="version" />
+  </a>
+  &nbsp; -->
   <a href="https://github.com/actions/typescript-action/actions"><img alt="typescript-action status" src="https://github.com/actions/typescript-action/workflows/build-test/badge.svg"></a>
+  <!-- &nbsp;
+  <a href="package_link_here">
+    <img src="https://img.shields.io/npm/dm/prompts.svg" alt="downloads" />
+  </a> -->
 </p>
 
-# Create a JavaScript Action using TypeScript
+<p align="center">
+  A GitHub action to validate Pull Request's title and description consistent convention
+</p>
 
-Use this template to bootstrap the creation of a TypeScript action.:rocket:
+<br />
 
-This template includes compilation support, tests, a validation workflow, publishing, and versioning guidance.  
+- **Pull Request Title**: Validate Pull Request's title convention against the regular expression.
+- **Pull Request Description**: Validate Pull Request's description convention against the regular expression.
+- **Valid Pull Request Label**: If the Pull Request's title and description convention is valid then a label will be attached on the Pull Request.
+- **Custom Regular Expression & Label name**: User can add custom regex to validate the Pull Request's title and description and can also add custom label name for valid Pull Request status.
 
-If you are new, there's also a simpler introduction.  See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action)
+##### Valid Pull Request
 
-## Create an action from this template
+<img src="./assets/images/check-list-passed.png" />
 
-Click the `Use this Template` and provide the new repo details for your action
+##### Invalid Pull Request
 
-## Code in Main
+<img src="./assets/images/check-list-failed.png" />
 
-> First, you'll need to have a reasonably modern version of `node` handy. This won't work with versions older than 9, for instance.
+![split](https://github.com/terkelg/prompts/raw/master/media/split.png)
 
-Install the dependencies  
-```bash
-$ npm install
-```
+## Usage
 
-Build the typescript and package it for distribution
-```bash
-$ npm run build && npm run package
-```
+Create a `.github/workflows/${YOUR_WORKFLOW_NAME}.yml` file in your GitHub repo and add the following code.
 
-Run the tests :heavy_check_mark:  
-```bash
-$ npm test
-
- PASS  ./index.test.js
-  ✓ throws invalid number (3ms)
-  ✓ wait 500 ms (504ms)
-  ✓ test runs (95ms)
-
-...
+```
+on:
+  pull_request:
+    types: [opened, edited, synchronize, reopened]
+
+jobs:
+  validate_pr:
+    runs-on: ubuntu-latest
+    name: Validate Pull Request
+    steps:
+      - name: validate PR
+        id: validatePR
+        uses: Techwards/pr-keeper@1.0
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
 ```
 
-## Change action.yml
-
-The action.yml defines the inputs and output for your action.
-
-Update the action.yml with your name, description, inputs and outputs for your action.
-
-See the [documentation](https://help.github.com/en/articles/metadata-syntax-for-github-actions)
+This GitHub action uses default regular expression for title and description convention validation and default label name if the pull request is valid.
 
-## Change the Code
+**Custom Action Values:** Users can also add their custom regular expression and custom label name. Follow the examples section.
 
-Most toolkit and CI/CD operations involve async operations so the action is run in an async function.
+![split](https://github.com/terkelg/prompts/raw/master/media/split.png)
 
-```javascript
-import * as core from '@actions/core';
-...
+## Examples
 
-async function run() {
-  try { 
-      ...
-  } 
-  catch (error) {
-    core.setFailed(error.message);
-  }
-}
+**Example 1:** Using custom title regular expression and default description regular expression and default label name
 
-run()
+```
+on:
+  pull_request:
+    types: [opened, edited, synchronize, reopened]
+
+jobs:
+  validate_pr:
+    runs-on: ubuntu-latest
+    name: Validate Pull Request
+    steps:
+      - name: validate PR
+        id: validatePR
+        uses: Techwards/pr-keeper@1.0
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          title-regex: >
+            ^Ticket\s\#[1-9]{1,}$
 ```
 
-See the [toolkit documentation](https://github.com/actions/toolkit/blob/master/README.md#packages) for the various packages.
+**Example 2:** Using custom description and default title regular expression and default label name
 
-## Publish to a distribution branch
+```
+on:
+  pull_request:
+    types: [opened, edited, synchronize, reopened]
+
+jobs:
+  validate_pr:
+    runs-on: ubuntu-latest
+    name: Validate Pull Request
+    steps:
+      - name: validate PR
+        id: validatePR
+        uses: Techwards/pr-keeper@1.0
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          description-regex: >
+            This\sPull Request\s(closes|fixes)\s\[\#[0-9]{1,}\]
+```
 
-Actions are run from GitHub repos so we will checkin the packed dist folder. 
+**Example 3:** Using default title and description regular expression and custom label name
 
-Then run [ncc](https://github.com/zeit/ncc) and push the results:
-```bash
-$ npm run package
-$ git add dist
-$ git commit -a -m "prod dependencies"
-$ git push origin releases/v1
+```
+on:
+  pull_request:
+    types: [opened, edited, synchronize, reopened]
+
+jobs:
+  validate_pr:
+    runs-on: ubuntu-latest
+    name: Validate Pull Request
+    steps:
+      - name: validate PR
+        id: validatePR
+        uses: Techwards/pr-keeper@1.0
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          validation-label: Valid Pull Request Convention
 ```
 
-Note: We recommend using the `--license` option for ncc, which will create a license file for all of the production node modules used in your project.
+**Example 4:** Using custom title and description regular expression and custom label name
 
-Your action is now published! :rocket: 
+```
+on:
+  pull_request:
+    types: [opened, edited, synchronize, reopened]
+
+jobs:
+  validate_pr:
+    runs-on: ubuntu-latest
+    name: Validate Pull Request
+    steps:
+      - name: validate PR
+        id: validatePR
+        uses: Techwards/pr-keeper@1.0
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          title-regex: >
+            ^Ticket\s\#[1-9]{1,}$
+          description-regex: >
+            This\sPull Request\s(closes|fixes)\s\[\#[0-9]{1,}\]
+          validation-label: Valid Pull Request Convention
+```
 
-See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
+![split](https://github.com/terkelg/prompts/raw/master/media/split.png)
 
-## Validate
+## Inputs table
 
-You can now validate the action by referencing `./` in a workflow in your repo (see [test.yml](.github/workflows/test.yml))
+| Name | Required | Default | Description |
+| ---- | -------- | ------- | ----------- |
+| `token` | `true` | `none` | A GitHub authentication token |
+| `title-regex` | `false` | ```^(Feature\|Fix\|Task)\s\|\sIssue\s\#[1-9]{1,}\s\|\s[\w\s\']\*$``` | A regular expression to validate the PR's title convention. Can also provide custom regular expression |
+| `description-regex` | `false` | ```This\sPR\scloses\s\[\#[0-9]{1,}\]\((https?:\/\/)?(?:www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b(?:[-a-zA-Z0-9()@:%_\+.~\#\?\&\/\=]*)\)``` | A regular expression to validate the PR's description convention. Can also provide custom regular expression |
+| `validation-label` | `false` | Ready for Review | A label will be attached on the PR if the PR is valid. Can also provide custom label name |
 
-```yaml
-uses: ./
-with:
-  milliseconds: 1000
-```
+## Credits
 
-See the [actions tab](https://github.com/actions/typescript-action/actions) for runs of this action! :rocket:
+[TypeScript GitHub Action Template](https://github.com/actions/typescript-action) by [GitHub Actions](https://github.com/actions).
 
-## Usage:
+## License
 
-After testing you can [create a v1 tag](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) to reference the stable and latest V1 action
+Distributed under the MIT License. See `LICENSE` for more information.

__tests__/main.test.ts

@@ -1,29 +1,6 @@
-import {wait} from '../src/wait'
-import * as process from 'process'
-import * as cp from 'child_process'
-import * as path from 'path'
 import {expect, test} from '@jest/globals'
 
-test('throws invalid number', async () => {
-  const input = parseInt('foo', 10)
-  await expect(wait(input)).rejects.toThrow('milliseconds not a number')
-})
-
-test('wait 500 ms', async () => {
-  const start = new Date()
-  await wait(500)
-  const end = new Date()
-  var delta = Math.abs(end.getTime() - start.getTime())
-  expect(delta).toBeGreaterThan(450)
-})
-
-// shows how the runner will run a javascript action with env / stdout protocol
-test('test runs', () => {
-  process.env['INPUT_MILLISECONDS'] = '500'
-  const np = process.execPath
-  const ip = path.join(__dirname, '..', 'lib', 'main.js')
-  const options: cp.ExecFileSyncOptions = {
-    env: process.env
-  }
-  console.log(cp.execFileSync(np, [ip], options).toString())
+test('dummy test', () => {
+  const input = true
+  expect(input).toBe(true)
 })

action.yml

@@ -1,11 +1,21 @@
-name: 'Your name here'
-description: 'Provide a description here'
-author: 'Your name or organization here'
+name: 'PR Keeper'
+description: 'A GitHub action that will validate the pull request'
+on: [pull_request]
 inputs:
-  milliseconds: # change this
+  token:
+    description: 'GitHub secret'
     required: true
-    description: 'input description here'
-    default: 'default value if applicable'
+  title-regex:
+    description: 'Regex for pull request title validation'
+    default: >
+      ^(Feature|Fix|Task)\s\|\sIssue\s\#[1-9]{1,}\s\|\s[\w\s\']*$
+  description-regex:
+    description: 'Regex for pull request description validation'
+    default: >
+      This\sPR\scloses\s\[\#[0-9]{1,}\]\((https?:\/\/)?(?:www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b(?:[-a-zA-Z0-9()@:%_\+.~\#\?\&\/\=]*)\)
+  validation-label:
+    description: 'Label to add when the pull request format is valid'
+    default: Ready for Review
 runs:
   using: 'node16'
   main: 'dist/index.js'