Merge pull request #3935 from citusdata/disallow-long-changelog

.circleci/config.yml

@@ -47,6 +47,9 @@ jobs:
       - run:
           name: 'Check if changed'
           command: git diff --exit-code
+      - run:
+          name: 'Check for lengths of changelog entries'
+          command: ci/disallow_long_changelog_entries.sh
       - run:
           name: 'Check for banned C API usage'
           command: ci/banned.h.sh

CHANGELOG.md

@@ -1072,7 +1072,7 @@
 
 * Adds user-facing UDFs for locking shard resources and metadata
 
-* Refactors connection and transaction management; giving a consistent experience
+* Refactors connection and transaction management; giving consistent experience
 
 * Enhances `COPY` with fully transactional semantics
 
@@ -1088,7 +1088,7 @@
 
 * Enhances `SERIAL` compatibility with MX tables
 
-* Adds an `node_connection_timeout` parameter to control node connection timeouts
+* Adds `node_connection_timeout` parameter to control node connection timeouts
 
 * Adds `enable_deadlock_prevention` setting to permit multi-node transactions
 

ci/disallow_long_changelog_entries.sh

@@ -0,0 +1,17 @@
+#! /bin/bash
+
+set -eu
+
+# Having changelog items with entries that are longer than 80 characters are forbidden.
+# Find all lines with disallowed length, and for all such lines store
+#  - line number
+#  - length of the line
+#  - the line content
+too_long_lines=$(awk 'length() > 80 {print NR,"(",length(),"characters ) :",$0}' CHANGELOG.md)
+
+if [[ -n $too_long_lines ]]
+then
+    echo "We allow at most 80 characters in CHANGELOG.md."
+    echo "${too_long_lines}"
+    exit 1
+fi

ci/fix_style.sh

@@ -11,5 +11,6 @@ cd ${cidir}/..
 ci/editorconfig.sh
 ci/remove_useless_declarations.sh
 ci/disallow_c_comments_in_migrations.sh
+ci/disallow_long_changelog_entries.sh
 
 citus_indent . --quiet