add readme.md

Author: dekinderfiets

README.md

@@ -1,116 +1,30 @@
-# Create a JavaScript Action
+# Pull Request Description Enforcer
 
-<p align="center">
-  <a href="https://github.com/actions/javascript-action/actions"><img alt="javscript-action status" src="https://github.com/actions/javascript-action/workflows/units-test/badge.svg"></a>
-</p>
+github action for enforcing description on pull requests
 
-Use this template to bootstrap the creation of a JavaScript action.:rocket:
-
-This template includes tests, linting, a validation workflow, publishing, and versioning guidance.
-
-If you are new, there's also a simpler introduction.  See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action)
-
-## Create an action from this template
-
-Click the `Use this Template` and provide the new repo details for your action
-
-## Code in Main
-
-Install the dependencies
-
-```bash
-npm install
-```
-
-Run the tests :heavy_check_mark:
-
-```bash
-$ npm test
-
- PASS  ./index.test.js
-  ✓ throws invalid number (3ms)
-  ✓ wait 500 ms (504ms)
-  ✓ test runs (95ms)
-...
-```
-
-## Change action.yml
-
-The action.yml contains 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)
-
-## Change the Code
-
-Most toolkit and CI/CD operations involve async operations so the action is run in an async function.
-
-```javascript
-const core = require('@actions/core');
-...
-
-async function run() {
-  try {
-      ...
-  }
-  catch (error) {
-    core.setFailed(error.message);
-  }
-}
-
-run()
-```
-
-See the [toolkit documentation](https://github.com/actions/toolkit/blob/master/README.md#packages) for the various packages.
-
-## Package for distribution
-
-GitHub Actions will run the entry point from the action.yml. Packaging assembles the code into one file that can be checked in to Git, enabling fast and reliable execution and preventing the need to check in node_modules.
-
-Actions are run from GitHub repos.  Packaging the action will create a packaged action in the dist folder.
-
-Run prepare
-
-```bash
-npm run prepare
-```
-
-Since the packaged index.js is run from the dist folder.
-
-```bash
-git add dist
-```
-
-## Create a release branch
+## Usage
 
-Users shouldn't consume the action from master since that would be latest code and actions can break compatibility between major versions.
+### Create Workflow
 
-Checkin to the v1 release branch
+Create a workflow (eg: `.github/workflows/pr-description-enforcer.yml` see [Creating a Workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file)) to utilize the action with content:
 
-```bash
-git checkout -b v1
-git commit -a -m "v1 release"
 ```
+# This workflow will enforce description on pull requests.
 
-```bash
-git push origin v1
-```
+name: 'PR Description Enforcer'
+on:
+    pull_request:
+        types: [opened, edited, reopened]
 
-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.
-
-Your action is now published! :rocket:
-
-See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
-
-## Usage
+jobs:
+    enforce:
+        runs-on: ubuntu-latest
 
-You can now consume the action by referencing the v1 branch
+        steps:
+            - uses: derkinderfietsen/pr-description-enforcer@v1
+              with:
+                  repo-token: '${{ secrets.GITHUB_TOKEN }}'
 
-```yaml
-uses: actions/javascript-action@v1
-with:
-  milliseconds: 1000
 ```
 
-See the [actions tab](https://github.com/actions/javascript-action/actions) for runs of this action! :rocket:
+_Note: This grants access to the `GITHUB_TOKEN` so the action can make calls to GitHub's rest API_

index.js

@@ -42,6 +42,7 @@ const getPrDescription = async (client) => {
     pull_number: prNumber
   });
 
+  // github adds \r\n on pr body
   return pullRequest.body.replace(/(\r\n)/g, '\n')
 }
 
@@ -70,7 +71,6 @@ const getPrTemplate = async (client, paths) => {
   }
 }
 
-// most @actions toolkit packages have async methods
 async function run() {
   try {
     const token = core.getInput("repo-token", { required: true });