[FEATURE] Add option to exclude the PR description from the check

README.md

@@ -53,6 +53,7 @@ jobs:
         with:
           pattern: '^[^#].{74}'
           error: 'The maximum line length of 74 characters is exceeded.'
+          excludeDescription: '1'
       - name: Check for Resolves / Fixes
         uses: gsactions/commit-message-checker@v1
         with:

__tests__/input-helper.test.ts

@@ -166,6 +166,27 @@ describe('input-helper tests', () => {
     expect(checkerArguments.messages[0]).toBe('some-title\n\nsome-body')
   })
 
+  it('excludes pull_request body payload', () => {
+    mockGitHub.context = {
+      eventName: 'pull_request',
+      payload: {
+        pull_request: {
+          title: 'some-title',
+          body: 'some-body'
+        }
+      }
+    }
+    inputs.pattern = 'some-pattern'
+    inputs.error = 'some-error'
+    inputs.excludeDescription = '1'
+    const checkerArguments: ICheckerArguments = inputHelper.getInputs()
+    expect(checkerArguments).toBeTruthy()
+    expect(checkerArguments.pattern).toBe('some-pattern')
+    expect(checkerArguments.error).toBe('some-error')
+    expect(checkerArguments.messages).toBeTruthy()
+    expect(checkerArguments.messages[0]).toBe('some-title')
+  })
+
   it('push payload is optional', () => {
     mockGitHub.context = {
       eventName: 'push',

action.yml

@@ -12,6 +12,10 @@ inputs:
   error:
     description: 'A error message which will be returned in case of an error.'
     required: true
+  excludeDescription:
+    description: 'Setting this input to 1 will exclude the Pull Request description from the check.'
+    required: false
+    default: ''
 runs:
   using: node12
   main: dist/index.js

dist/index.js

@@ -8741,8 +8741,10 @@ function getInputs() {
     result.flags = core.getInput('flags');
     // Get error message
     result.error = core.getInput('error', { required: true });
+    // Get excludeDescription
+    const excludeDescription = core.getInput('excludeDescription') !== '';
     // Get error message
-    result.messages = getMessages();
+    result.messages = getMessages(excludeDescription);
     return result;
 }
 exports.getInputs = getInputs;
@@ -8752,15 +8754,15 @@ exports.getInputs = getInputs;
  *
  * @returns   string[]
  */
-function getMessages() {
+function getMessages(excludeDescription) {
     const messages = [];
     switch (github.context.eventName) {
         case 'pull_request': {
             if (github.context.payload &&
                 github.context.payload.pull_request &&
                 github.context.payload.pull_request.title) {
                 let message = github.context.payload.pull_request.title;
-                if (github.context.payload.pull_request.body) {
+                if (github.context.payload.pull_request.body && !excludeDescription) {
                     message = message.concat('\n\n', github.context.payload.pull_request.body);
                 }
                 messages.push(message);

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gsactions/commit-message-checker",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "GitHub Action that checks commit messages of pushes and pull request against a regex pattern",
   "keywords": [
     "github",

src/input-helper.ts

@@ -39,8 +39,11 @@ export function getInputs(): ICheckerArguments {
   // Get error message
   result.error = core.getInput('error', {required: true})
 
+  // Get excludeDescription
+  const excludeDescription = core.getInput('excludeDescription') !== ''
+
   // Get error message
-  result.messages = getMessages()
+  result.messages = getMessages(excludeDescription)
 
   return result
 }
@@ -51,7 +54,7 @@ export function getInputs(): ICheckerArguments {
  *
  * @returns   string[]
  */
-function getMessages(): string[] {
+function getMessages(excludeDescription: boolean): string[] {
   const messages: string[] = []
 
   switch (github.context.eventName) {
@@ -62,7 +65,7 @@ function getMessages(): string[] {
         github.context.payload.pull_request.title
       ) {
         let message: string = github.context.payload.pull_request.title
-        if (github.context.payload.pull_request.body) {
+        if (github.context.payload.pull_request.body && !excludeDescription) {
           message = message.concat(
             '\n\n',
             github.context.payload.pull_request.body