Merge pull request #2 from aschbacd/bug-1

Fix commit message body blank lines

Author: aschbacd

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Dominik Aschbacher
+Copyright (c) 2021 Dominik Aschbacher
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -21,7 +21,7 @@ jobs:
     name: GitLint
     steps:
       - name: Lint commits, branches, and pull requests
-        uses: aschbacd/[email protected].0
+        uses: aschbacd/[email protected].1
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           commit-message-body-max-length: 72
@@ -43,6 +43,7 @@ The following input keys can be used in your GitHub Actions workflow (shown abov
 | commit-message-subject-max-length  | Max. characters for commit message subject                   | -1 (disabled)           | 50                            |
 | commit-message-subject-min-length  | Min. characters for commit message subject                   | -1 (disabled)           | -1 (disabled)                 |
 | github-token                       | Token used to authenticate against GitHub api                | `-`                     | `${{ secrets.GITHUB_TOKEN }}` |
+| prohibit-blank-lines-cm-body       | Commit message body cannot include blank lines               | `false`                 | `false`                       |
 | prohibit-unknown-commit-authors    | Commit author must be GitHub user                            | `false`                 | `true`                        |
 | prohibit-unknown-commit-committers | Commit committer must be GitHub user                         | `false`                 | `true`                        |
 | prohibit-unsigned-commits          | Commits without a valid signature are invalid                | `false`                 | `false`                       |

action.yml

@@ -23,6 +23,10 @@ inputs:
   github-token:
     description: "GitHub token used to access api"
     required: true
+  prohibit-blank-lines-cm-body:
+    description: "Prohibit blank lines in commit message body"
+    required: false
+    default: false
   prohibit-unknown-commit-authors:
     description: "Prohibit commit authors that are not known to GitHub"
     required: false

index.js

@@ -33,6 +33,7 @@ async function run() {
     const commitMessageSubjectMaxLength = parseInt(core.getInput('commit-message-subject-max-length'))
     const commitMessageSubjectMinLength = parseInt(core.getInput('commit-message-subject-min-length'))
 
+    const prohibitBlankLinesCmBody = (core.getInput('prohibit-blank-lines-cm-body') == 'true')
     const prohibitUnknownCommitAuthors = (core.getInput('prohibit-unknown-commit-authors') == 'true')
     const prohibitUnknownCommitCommitters = (core.getInput('prohibit-unknown-commit-committers') == 'true')
     const prohibitUnsignedCommits = (core.getInput('prohibit-unsigned-commits') == 'true')
@@ -73,10 +74,10 @@ async function run() {
       core.info(`Commit hash: ${commit.sha}`)
       core.info(`Commit author email: ${commit.commit.author.email}`)
       core.info(`Commit author name: ${commit.commit.author.name}`)
-      core.info(`Commit author GitHub account: ${commit.author}`)
+      core.info(`Commit author GitHub account: ${commit.author == null ? undefined : commit.author.login}`)
       core.info(`Commit committer email: ${commit.commit.committer.email}`)
       core.info(`Commit committer name: ${commit.commit.committer.name}`)
-      core.info(`Commit committer GitHub account: ${commit.committer}`)
+      core.info(`Commit committer GitHub account: ${commit.committer == null ? undefined : commit.committer.login}`)
       core.info(`Commit has valid signature: ${commit.commit.verification.verified}`)
       core.info(`Commit message subject: ${commitMessageSubject}`)
       core.info(`Commit message body: ${commitMessageBody}`)
@@ -118,8 +119,12 @@ async function run() {
       // Check commit message body
       if (commitMessageBody != null) {
         commitMessageBody.split("\n").forEach(function (line, index) {
-          if (commitMessageBodyMinLength != -1 && line.length < commitMessageBodyMinLength)
+          if (line.length == 0) {
+            if (prohibitBlankLinesCmBody)
+              core.setFailed(`Blank lines are not allowed in commit message body; line ${(index+1).toString()} (${commit.sha.substr(0, 7)})`)
+          } else if (commitMessageBodyMinLength != -1 && line.length < commitMessageBodyMinLength) {
             core.setFailed(`Commit message body line ${(index+1).toString()} is too short (${commit.sha.substr(0, 7)})`)
+          }            
 
           if (commitMessageBodyMaxLength != -1 && line.length > commitMessageBodyMaxLength)
             core.setFailed(`Commit message body line ${(index+1).toString()} is too long (${commit.sha.substr(0, 7)})`)

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "gitlint-action",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "This GitHub Action ensures that your naming conventions for commits, branches, and pull requests are being respected.",
   "main": "index.js",
   "scripts": {