@toptal/davinci-ci 1.13.4-alpha-fx-2225-create-an-eslint-rule-regarding-usage-fc-in-the-components.1335 → 1.13.4-alpha-fx-2196-improve-commit-validation-message.1335

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-ci",
-  "version": "1.13.4-alpha-fx-2225-create-an-eslint-rule-regarding-usage-fc-in-the-components.1335+57b89f8",
+  "version": "1.13.4-alpha-fx-2196-improve-commit-validation-message.1335+fdbf7f9",
   "description": "Continuos integrations tools for frontend projects",
   "publishConfig": {
     "access": "public"
@@ -32,9 +32,9 @@
   "dependencies": {
     "@commitlint/cli": "^12.1.4",
     "@commitlint/config-conventional": "^12.1.4",
-    "@toptal/davinci-cli-shared": "1.4.2-alpha-fx-2225-create-an-eslint-rule-regarding-usage-fc-in-the-components.1335+57b89f8",
+    "@toptal/davinci-cli-shared": "1.4.2-alpha-fx-2196-improve-commit-validation-message.1335+fdbf7f9",
     "danger": "^10.7.1",
     "markdown-table": "^2.0.0"
   },
-  "gitHead": "57b89f822716c5e4cc2b470a147476d45e2254ff"
+  "gitHead": "fdbf7f9105a7334e746c12f6381151d3be99b216"
 }

package/src/commands/danger.js

@@ -36,7 +36,7 @@ const dangerCommand = ({ options }) => {
     : toptalCommitsDangerfilePath
 
   runSync(
-    'npx',
+    'yarn',
     [
       'danger',
       local ? 'local' : 'ci',

package/src/configs/danger/toptal/config.js

@@ -1,6 +1,12 @@
 const WHITELISTED_USERS = ['dependabot-preview[bot]', 'dependabot[bot]', 'toptal-devbot']
 const VALID_PR_CODE_REGEX = /\[[A-Z]{1,4}-.*]\s/
-const VALID_COMMIT_MESSAGE_REGEX = /^[A-Z]\w[^.\n]*[^.\s](\n\n(.|\n)*)*$/
+// Valid commit titles:
+// "Regular commit message"
+// "Commit with sentence. But does not end with a full-stop"
+// "[FOO-1234] Commit with prefix"
+// "[FOO] Prefix numbers can be omitted"
+// "[FOO][BAR] Prefixes can couple"
+const VALID_COMMIT_TITLE_REGEX = /^((\[[A-Z]+(-\d+)?])+ )?[A-Z]\w[^\n]*[^.]$/
 const MAX_COMMIT_LINE_LENGTH = 79
 const ENGINEERING_DOCS_LINK =
   'https://toptal-core.atlassian.net/wiki/spaces/ENG/pages/210665897/Commit+Message+Quality'
@@ -14,7 +20,7 @@ module.exports = {
   ENGINEERING_DOCS_LINK,
   MAX_COMMIT_LINE_LENGTH,
   MISSING_TICKET_CODE_ERROR_MESSAGE,
-  VALID_COMMIT_MESSAGE_REGEX,
+  VALID_COMMIT_TITLE_REGEX,
   VALID_PR_CODE_REGEX,
   WHITELISTED_USERS
 }

package/src/configs/danger/toptal/plugins/toptal-commits/index.js

@@ -1,6 +1,6 @@
 const {
   MAX_COMMIT_LINE_LENGTH,
-  VALID_COMMIT_MESSAGE_REGEX,
+  VALID_COMMIT_TITLE_REGEX,
   WHITELISTED_USERS
 } = require('../../config')
 
@@ -8,14 +8,20 @@ const validateCommitMessage = message => {
   const errors = []
   const [title = '', body = ''] = message.split(/\n\n/)
   const bodyLines = body.split(/\n/)
-  const isFormatValid = VALID_COMMIT_MESSAGE_REGEX.test(message)
+  const isTitleFormatValid = VALID_COMMIT_TITLE_REGEX.test(title)
   const isTitleLengthValid = title.length <= MAX_COMMIT_LINE_LENGTH
   const isBodyLinesLengthValid = bodyLines.every(
     line => line.length <= MAX_COMMIT_LINE_LENGTH
   )
 
-  if (!isFormatValid) {
-    errors.push('- format of commit title or body is not correct')
+  if (!isTitleFormatValid) {
+    errors.push(`- format of commit title is not correct ([read more](https://toptal-core.atlassian.net/wiki/spaces/ENG/pages/210665897/Commit+Message+Quality)): 
+  - Title should start with capital letter
+  - Title should not end with a full-stop (i.e .)\n
+  Example of a valid commit title:
+    - Regular commit message
+    - [FOO-1234] Commit with prefix
+    - [FOO][BAR] Coupled prefixes`)
   }
 
   if (!isTitleLengthValid) {

package/src/configs/danger/toptal/plugins/toptal-pr-title/index.js

@@ -1,5 +1,5 @@
 const {
-  VALID_COMMIT_MESSAGE_REGEX,
+  VALID_COMMIT_TITLE_REGEX,
   VALID_PR_CODE_REGEX,
   WHITELISTED_USERS,
   DEFAULT_PR_TITLE_ERROR_MESSAGE,
@@ -47,7 +47,7 @@ const toptalPRTitle = () => {
   }
 
   const titleText = splitTitle[splitTitle.length - 1]
-  const isTitleFormatValid = VALID_COMMIT_MESSAGE_REGEX.test(titleText)
+  const isTitleFormatValid = VALID_COMMIT_TITLE_REGEX.test(titleText)
 
   if (!isTitleFormatValid) {
     showError()

package/src/configs/jobs/pr-tests/Jenkinsfile

@@ -166,7 +166,7 @@ pipeline {
             -e BUILD_URL=${BUILD_URL} \
             -e DANGER_GITHUB_API_TOKEN=${DANGER_GITHUB_API_TOKEN} \
             gcr.io/toptal-hub/${repositoryName}:${commitId} \
-            npx davinci ci danger
+            yarn davinci ci danger
           """
         }
       } //steps

package/src/configs/jobs/publish-alpha-package/Jenkinsfile

@@ -126,7 +126,7 @@ pipeline {
             -v ${PWD}/.git:/app/.git \
             gcr.io/toptal-hub/${repositoryName}:${commitId} \
             /bin/bash -c "yarn ${params.BUILD_PACKAGE_SCRIPT_NAME} && \
-            npx davinci engine publish-package \
+            yarn davinci engine publish-package \
             --alpha \
             --outputVersion /artifacts/.version \
             --branch ${sourceBranch}"